Getting Started

Keyword Performance

Returns time-series on-site search performance data for a specific keyword on Amazon.

Variants:

Time-series (this endpoint): GET /v5/shopper-on-site-search/keywords/performance — data broken down by date for trend analysis.
Aggregated: GET /v5/shopper-on-site-search/keywords/performance/aggregated — a single summary across the entire date range.

Both variants accept the same input parameters. The time-series response includes a date field per record; the aggregated response omits it and returns one consolidated row.

Possible output fields:

date: Date of the data point (time-series only)
clicks: Total clicks for this keyword
paid_clicks: Paid clicks for this keyword
organic_clicks: Organic clicks for this keyword
search_volume: Total number of searches for this keyword
associated_brand: The brand most associated with this keyword
top_brand: The brand with the highest click share for this keyword
top_brand_share: Top brand's share of total clicks for this keyword

Constraints:

domain and keyword are required
granularity supports monthly or weekly

This endpoint uses data credits. See the data credits guide to estimate costs.

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: clicks, paid_clicks, organic_clicks, search_volume, associated_brand, top_brand, top_brand_share

Enum values:

clickspaid_clicksorganic_clickssearch_volumeassociated_brandtop_brandtop_brand_share

mtdboolean

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

keywordstring Required

Search keyword or keyword ID. Can be a plain text keyword (e.g., 'laptop') or a keyword ID if known. Keywords are case-insensitive for matching. Use keyword search or top keywords endpoints to discover available keywords

formatstring

Format in which the reply should be returned

Enum values:

jsonxml

Response

200

Object

Success

Response Attributes

metaobject

Show child attributes

dataarray

Nullable:

True

Show child attributes

Sections

Keyword Performance

Header Parameters

Query Parameters

Response

Response Attributes

What made this section helpful for you?

What made this section unhelpful for you?

Response

What made this section helpful for you?

What made this section unhelpful for you?

Sections

Keyword Performance

Header Parameters

Query Parameters

ResponseExpand all

Response Attributes

What made this section helpful for you?

What made this section unhelpful for you?

Response

What made this section helpful for you?

What made this section unhelpful for you?

Ask an AI

Code with AI

Response