Getting Started

Sections

Theme switcher

Product Top Keywords

Header Parameters

api-keystring

Query Parameters

domainstring Required

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

granularitystring

Time granularity for the returned values

Enum values:
monthlyweekly
start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity, automatically adjusted to the first Sunday of the specified month.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

metricsarray

Comma-separated list of metrics: keyword, associated_brand, branded_type, organic_rank, relevancy, share_of_clicks, keyword_clicks, product_organic_clicks, product_paid_clicks, search_volume, reach, product_clicks

Style
form
Enum values:
keywordassociated_brandbranded_typeorganic_rankrelevancyshare_of_clickskeyword_clicksproduct_organic_clicksproduct_paid_clickssearch_volume
... 2 other enums
mtdboolean

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

asinstring Required

Amazon Standard Identification Number. Must be exactly 10 characters (uppercase alphanumeric only). Format: 10 uppercase letters and/or numbers (e.g., 'B0DLFVP6YM'). ASINs are Amazon-specific and cannot be used across different Amazon domains

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