Retrieve recommendation pages

šŸ” This endpoint requires HTTP authentication (either Basic or Bearer).
For authenticating with Bearer token, required scopes are: recommendations(r).

Beta: This endpoint is in beta and may change. It is currently available to a small group of users. To request access, contact your Customer Success Manager.

Return the pages configured for the selected key and section, ordered by page_id, with the total number of matches. Pass pod_id to return only the pages that list that pod, such as to find the pages that block deleting it.

Query Params
string
required
length between 1 and 100

The key of the index to use.

string
length between 1 and 100

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

string

Filters the results to pages that serve the specified recommendation pod.

integer
1 to 100
Defaults to 20

The number of results per page to return.

integer
≄ 1

The page of results to return.

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.

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
:
LoadingLoading…
Response
Choose an example:
application/json