Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Facet campaigns

Create facet campaign

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: facets.refined_filters(w), facets.refined_queries(w).

Create a facet campaign

post/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

Request body

namestring required
descriptionstring

The description of the facet campaign.

Example request

{
  "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"
    }
  ]
}

Response

Created

idinteger required

The ID of the facet rule campaign.

namestring required

The name of the facet rule campaign.

descriptionstring

The description of the facet rule campaign.

created_atstring date-time required

The creation time of the facet rule campaign.

updated_atstring date-time required

The last updated time of the facet rule campaign.

Example response

{
  "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"
    }
  ]
}