List top on-site search keywords 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
Comma-separated metrics: keyword, keyword_total_clicks, keyword_clicks_change, selected_brand_clicks, selected_brand_share, top_brand, top_brand_share.
keywordkeyword_total_clickskeyword_clicks_changeselected_brand_clicksselected_brand_sharetop_brandtop_brand_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 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.
Filter keywords containing this text.
Filter keywords not containing this text.
Minimum keyword total clicks.
Maximum keyword total clicks.
Minimum selected brand clicks.
Maximum selected brand clicks.
Minimum selected brand share.
Maximum selected brand share.
Filter results to keywords where the top-clicked brand.
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