Download search terms as CSV

Downloads search term data as a CSV file.

Downloads search term data as a CSV file. Supports the same filters as the List search terms endpoint but returns the full result set in CSV format rather than paginated JSON.

Request

GET /search-term/download

Query Parameters

ParameterTypeDefaultDescription
sincestring1dTime range to look back (e.g. 1d, 7d, 30d).
languagestringFilter by shop language (e.g. de, en).
_startinteger0Starting offset within the result set.
_countinteger10000Maximum number of rows to include in the download.
includeHeaderbooleantrueWhen true, the first row of the CSV contains column headers.
includeBotTrafficbooleanfalseWhen true, search terms from detected bot traffic are included.
hitsbooleantrueWhen true, returns search terms with results. When false, returns zero-result search terms.

Headers

HeaderValue
AuthorizationBearer <token>

Response

Returns a CSV file with Content-Type: text/csv and a Content-Disposition: attachment; filename="result.csv" header.

CSV Columns

ColumnDescription
Search termThe search term entered by the shopper.
Number of hitsNumber of times this search term was recorded within the requested time range.

Example Response

Search term,Number of hits
running shoes,142
winter jacket,87
blue jeans,54
Query Params
string
Defaults to 1d

Time range

string

Shop language

integer
Defaults to 0
integer
Defaults to 10000
boolean
Defaults to true
boolean
Defaults to false
boolean
Defaults to true
Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/csv