Brand/Category performance for a CRIQ custom category (aggregated)
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
Comma-separated metrics: domain, views, number_of_skus, category_views, category_number_of_skus, views_share.
domainviewsnumber_of_skuscategory_viewscategory_number_of_skusviews_shareWhen 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 two-letter market code (e.g., 'us', 'uk'). Omit to include all markets. Use describe to list supported values.
When true, aggregates results across domains. Defaults to false on aggregated endpoints.
When true, aggregates results across time; date is omitted from rows. Defaults to true on aggregated endpoints.
Optional brand name. When provided, returns brand vs category metrics; when omitted, returns category performance only.
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
Response Attributes
Show child attributes
Show child attributes
Response