Collections Structure

{
"request": {
...
},
"response": {
"collection": {
"collection_id": "my_collection",
"display_name": "Collection",
"data": {"foo": "bar"}
},
"facets": [
...
],
"groups": [
...
],
"sort_options": [
...
],
"results": [
...
],
"total_num_results": 10
}
}

Collection fields#

field_nameAlways present?Description
idYesId of browsed collection.
display_nameYesDisplay name of the collection.
dataYesJSON object with custom metadata attached with the collection.