COconstructor
Recommendation pages

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.

get/v1/recommendation_pages

Request

  • Base URL
    https://ac.cnstrc.com
  • URL
    https://ac.cnstrc.com/v1/recommendation_pages
  • Auth
    • HTTP basic
    • or HTTP bearer

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
pod_idstring

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

Example:similar_items
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

Response

OK

total_countinteger required

The total number of pages matching the request, before pagination.

Example response

{
  "pages": [
    {
      "page_id": "pdp_b2c",
      "display_name": "PDP - B2C",
      "pods": [
        {
          "pod_id": "similar_items"
        }
      ],
      "created_at": "2021-01-01T00:00:00",
      "updated_at": "2021-02-01T00:00:00"
    }
  ],
  "total_count": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.