v1
latestOpenAPI 3.1.02026-07-241765501.1 MBFacet campaigns
Retrieve facet campaigns
🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: facets.refined_filters(r), facets.refined_queries(r).
Retrieve facet campaigns.
get/v1/facet_rule_campaigns
Query parameters
keystring required
The key of the index to use.
Example:key_K2pX7vBnU0bgA5xp
sectionstring
The section of the index to use. Defaults to Products.
Example:Products
refined_filtersobject
A list of refined filters.
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.
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
refined_queriesstring[]
A list of refined queries.
Response
OK
Example response
{
"facet_rule_campaigns": [
{
"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": {
"name": "Brand",
"position": 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": {
"name": "Brand"
}
}
],
"refined_queries": [
{
"query": "shoes"
}
],
"refined_filters": [
{
"filter_name": "brand",
"filter_value": "Nike"
}
]
}
]
}