Getting Started

Sections

Theme switcher

List top on-site search keywords 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

Comma-separated metrics: keyword, keyword_total_clicks, keyword_clicks_change, selected_brand_clicks, selected_brand_share, top_brand, top_brand_share.

Style
form
Enum values:
keywordkeyword_total_clickskeyword_clicks_changeselected_brand_clicksselected_brand_sharetop_brandtop_brand_share
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.

keyword_containsstring

Filter keywords containing this text.

keyword_not_containsstring

Filter keywords not containing this text.

keyword_total_clicks_minnumber

Minimum keyword total clicks.

keyword_total_clicks_maxnumber

Maximum keyword total clicks.

selected_brand_clicks_minnumber

Minimum selected brand clicks.

selected_brand_clicks_maxnumber

Maximum selected brand clicks.

selected_brand_share_minnumber

Minimum selected brand share.

selected_brand_share_maxnumber

Maximum selected brand share.

top_brandsarray

Filter results to keywords where the top-clicked brand.

Style
form
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