Getting Started

Sections

Theme switcher

List top products for a CRIQ custom category

Header Parameters

api-keystring

Query Parameters

granularitystring

Time granularity for the returned values

Enum values:
weekly
start_datestring Required

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

end_datestring Required

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

metricsarray

Optional comma-separated list of fields to return: product_id, title, product_url, views, yoy_views_change, brand. When omitted, all fields are returned. Unselected fields are returned as null. The date, domain, and brand fields are always included and are not controlled by this parameter.

Style
form
Enum values:
product_idviewsyoy_views_changetitleproduct_url
mtdboolean

When true with weekly granularity, end_date is set to the latest available Saturday. NOT supported for monthly granularity.

category_idstring Required

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints).

domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Style
form
brandsarray

Optional comma-separated brand names to restrict results (case-sensitive matching per gateway).

Style
form
market_codestring

Optional two-letter market code (e.g., 'us', 'uk'). Omit to include all markets. Use describe to list supported values.

views_mininteger

Optional minimum estimated product page views

views_maxinteger

Optional maximum estimated product page views. Must be >= views_min when both are set.

title_containsstring

Product title must contain this substring.

title_not_containsstring

Product title must not contain this substring.

formatstring

Format in which the reply should be returned

Enum values:
jsonxml
limitinteger

Sets how many results to return.

offsetinteger

Defines the number of results to skip

ascboolean | null

Orders the results by ascending or descending

sortstring

Selects a specific metric to order results by

Response

200
Object

OK

Response Attributes

metaobject

Show child attributes

dataarray | null

Show child attributes

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot