List top products for a CRIQ custom category
Header Parameters
Query Parameters
Time granularity for the returned values
weeklyStart date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago
End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago
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.
product_idviewsyoy_views_changetitleproduct_urlWhen true with weekly granularity, end_date is set to the latest available Saturday. NOT supported for monthly granularity.
Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints).
Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.
Optional comma-separated brand names to restrict results (case-sensitive matching per gateway).
Optional two-letter market code (e.g., 'us', 'uk'). Omit to include all markets. Use describe to list supported values.
Optional minimum estimated product page views
Optional maximum estimated product page views. Must be >= views_min when both are set.
Product title must contain this substring.
Product title must not contain this substring.
Format in which the reply should be returned
jsonxmlSets how many results to return.
Defines the number of results to skip
Orders the results by ascending or descending
Selects a specific metric to order results by
Response
OK