COconstructor
Offsite Discovery results

Retrieve recommendations by pod

Retrieve AI-optimized recommendation results for products by pod identifier.

get/v1/recommendations/pods/{pod_id}

Request

  • Base URL
    https://offsite-discovery.cnstrc.com
  • URL
    https://offsite-discovery.cnstrc.com/v1/recommendations/pods/{pod_id}
  • Auth
    none required

Path parameters

pod_idstring required

The unique identifier of the recommendation pod containing the product set.

Example:homepage_products

Query parameters

keystring required

The key of the index to use.

Example:ZqXaOfXuBWD4s3XzCI1q
campaign_idstring required

Email campaign identifier for tracking and analytics.

Example:email_campaign_2024_01
string[]
OR
string
object
OR
object
filter_namestring

DEPRECATED. Please, use 'filters' instead. Name of the product attribute to filter by (e.g., brand, category, color). Must be provided together with filter_value.

Example:brand
filter_valuestring

DEPRECATED. Please, use 'filters' instead. Value to filter the specified attribute by. Must be provided together with filter_name.

Example:nike
num_resultsinteger

The maximum number of recommended items to retrieve.

Example:10
cstring

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

Example:cio-dashboard
string[]
OR
string
uistring

Unique identifier for the user to personalize recommendation results.

Example:user_12345
base_urlstring

Base URL used to construct the product detail page redirect URL (e.g., 'https://example.com').

Response

OK. A list of recommended products.

valuestring

The name or title of the product (corresponds to item_name from OpenAPI example).

Example response

[
  {
    "data": {
      "id": "PROD123",
      "variation_id": "VAR456",
      "url": "https://example.com/products/prod123",
      "image_url": "https://example.com/images/prod123.jpg"
    },
    "value": "Classic Blue T-Shirt",
    "strategy": {
      "id": "bestsellers"
    },
    "labels": {
      "is_retail_media": true,
      "sl_campaign_id": "campaign_123",
      "sl_campaign_owner": "brand_abc"
    }
  }
]

Changes

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