v1
latestOpenAPI 3.1.02026-07-241765501.1 MBSearchandising for Collections
Retrieve refined collection
🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: searchandising.refined_collections(r).
Retrieve a refined collection.
get/v1/refined_collections/{collection_id}
Path parameters
collection_idstring required
Query parameters
keystring required
The key of the index to use.
Example:key_K2pX7vBnU0bgA5xp
response_section'results' | 'facets'
sectionstring
The section of the index to use. Defaults to Products.
Example:Products
filter_names_to_excludestring[]
A list of filter names to exclude from results.
num_results_per_pageinteger
The number of results per page to return.
Example:20
pageinteger
The page of results to return.
Example:1
offsetinteger
The number of results to skip from the beginning. Cannot be used together with page.
sort_by'id' | 'created_at' | 'updated_at' | 'last_updated_internally' | 'last_updated_externally'
The attribute to sort by.
Example:id
sort_order'ascending' | 'descending'
cstring
The ID of the client and version that the request is coming from, such as cio-js-2.90.
Example:cio-js-2.90
filterobject
A list of filters to retrieve
Response
OK
Example response
{
"refined_collections": [
{
"slot_rules": [
{
"request_tag_value": "premium",
"active": true,
"start_time": "2024-03-06T16:05:19",
"end_time": "2024-03-06T17:05:19",
"campaign_id": 1,
"rule": {
"item_id": "nike-shoes",
"variation_slice": {
"color": [
"red"
]
},
"position": 1,
"labels": {
"promoted": true
}
}
}
],
"whitelist_rule": {
"request_tag_value": "premium",
"active": true,
"start_time": "2024-03-06T16:05:19",
"end_time": "2024-03-06T17:05:19",
"campaign_id": 1
},
"blacklist_rules": [
{
"request_tag_value": "premium",
"active": true,
"start_time": "2024-03-06T16:05:19",
"end_time": "2024-03-06T17:05:19",
"campaign_id": 1,
"rule": {
"item_ids": [
"nike-shoes"
]
}
}
],
"boost_rules": [
{
"request_tag_value": "premium",
"active": true,
"start_time": "2024-03-06T16:05:19",
"end_time": "2024-03-06T17:05:19",
"campaign_id": 1,
"rule": {
"item_ids": [
"nike-shoes"
],
"boost": -5
}
}
],
"content_rules": [
{
"request_tag_value": "premium",
"active": true,
"start_time": "2024-03-06T16:05:19",
"end_time": "2024-03-06T17:05:19",
"campaign_id": 1,
"rule": {
"data": {
"banner_url": "https://example.com/banner.jpg"
}
}
}
],
"filters_slot_rules": [
{
"request_tag_value": "premium",
"active": true,
"start_time": "2024-03-06T16:05:19",
"end_time": "2024-03-06T17:05:19",
"campaign_id": 1,
"rule": {
"position_ranges": [
{
"start": 1,
"end": 3
}
]
}
}
],
"variation_slicing_rule": {
"request_tag_value": "premium",
"active": true,
"start_time": "2024-03-06T16:05:19",
"end_time": "2024-03-06T17:05:19",
"campaign_id": 1,
"rule": {
"facet_names": [
"color"
]
}
}
}
]
}