Retrieve campaigns

get

https://ac.cnstrc.com/v1/campaigns

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: searchandising.campaigns(r), searchandising.recommendations(r).

Retrieve campaigns.

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

section

string

length between 1 and 100

The section of the index to use. Defaults to Products.

The ID(s) of campaigns to filter by.

refined_filters

object

A list of refined filters.

num_results_per_page

integer

1 to 100

Defaults to 20

The number of results per page to return.

page

integer

≥ 1

The page of results to return.

offset

integer

≥ 0

The number of results to skip from the beginning. Cannot be used together with page.

string

length between 1 and 100

The ID of the client and version that the request is coming from, such as cio-js-2.90.

refined_recommendation_contexts

object

A filter for refined recommendation contexts.

refined_queries

array of strings

length ≥ 1

A list of refined queries.

Refined Queries

Responses

400

Validation Error

401

Credentials are not passed or action is forbidden.

403

The supplied token does not have the required permissions.

429

Rate limit breached

Language

Credentials

Response

Choose an example:

application/json

👋 Welcome to Constructor's new and improved documentation

200OK