Skip to main content
GET
Export keyword search results as XLSX

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

query
required

Search query - one or more keywords to search for

Minimum string length: 1
Example:

"laptop"

method
enum<string>

Search method to use

Available options:
exact,
similar
Example:

"similar"

exclude_query

Negative keyword query to exclude from similar/full-text keyword searches. Ignored for exact searches.

Example:

"decaf"

type
enum<string>

Data frequency type

Available options:
weekly,
monthly
Example:

"monthly"

page
integer

Page number for pagination

Required range: x >= 1
Example:

1

limit
integer

Number of results per page (max 1000)

Required range: 1 <= x <= 1000
Example:

50

brand

Filter by brand name(s)

product

Filter by product ASIN(s)

category

Filter by friendly category bucket name(s). Known stored category names are also accepted; unmatched values are treated as Other.

order_by

Field to sort results by, or a period (MM-YYYY/WW-YYYY)

Available options:
latest_period,
latest_rank,
best_rank,
worst_rank,
avg_rank,
total_periods,
fts_rank,
similarity_score,
best_match
Example:

"latest_period"

order_direction
enum<string>

Sort direction

Available options:
asc,
desc,
ASC,
DESC
Example:

"DESC"

exclude_nulls

Exclude results with null values in the latest period

Example:

false

format
enum<string>

Value format for period columns in exports

Available options:
raw,
delta,
percentage
Example:

"raw"

color_threshold
integer | null

Percentage threshold for color coding (0-50). Changes below this threshold show as neutral.

Required range: 0 <= x <= 50
Example:

20

Response

Keyword search export generated.

The response is of type file.