About this endpoint
What it does
Exports bulk keyword metrics for the keywords you submit, using the selected source query parameter and request body options for sorting and optional history range filtering. The success response is a JSON array of keyword metric objects.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| source | String | Yes | Keyword data source. |
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| keywords | String Array | Yes | List of keywords to export. Minimum 1 item, maximum 5000 items. |
| sort | ENUM | No | Sort field. Allowed values: volume, cpc, difficulty, competition. Default: cpc. |
| sort_order | ENUM | No | Sort direction. Allowed values: asc, desc. Default: desc. |
| history_to | String | No | Date in date format. Day is ignored; defaults to current month. |
| history_from | String | No | Date in date format. Day is ignored; only takes effect together with history_to. |
Response
Returns a JSON array of objects. Each object may include keyword metrics such as keyword (string), volume (integer), cpc (number), difficulty (integer), competition (number), intents (string array of I, C, T, L, or N), history_trend (object keyed by YYYY-MM-DD with integer values), and is_data_found (boolean).
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| cpc | Number | No | CPC value as a floating-point number. |
| volume | Integer | No | Search volume. |
| intents | String Array | No | Intent codes. Allowed values: I, C, T, L, N. |
| keyword | String | No | Keyword text. |
| difficulty | Integer | No | Keyword difficulty. |
| competition | Number | No | Competition value as a floating-point number. |
| history_trend | Object | No | Keyed by YYYY-MM-DD (first of month). Values are integers. |
| is_data_found | Boolean | No | Indicates whether data was found. |
Notes
keywords accepts up to 5000 items, so large bulk exports should be split before submission if you need to stay within the schema limit.