learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
},
"location_name": {
"type": "string",
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:United States"
},
"location_code": {
"type": "integer",
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:2840"
},
"language_name": {
"type": "string",
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en"
},
"depth": {
"type": [
"integer",
"null"
],
"description": "keyword search depth
optional field
default value: 1;
number of the returned results depends on the value you set in this field;
you can specify a level from 0 to 4;
estimated number of keywords for each level (maximum):
0 - the keyword set in the keyword field
1 – 6 keywords
2 – 42 keywords
3 – 258 keywords
4 – 1554 keywords"
},
"include_seed_keyword": {
"type": [
"boolean",
"null"
],
"description": "include data for the seed keyword
optional field
if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response
default value: false"
},
"ignore_synonyms": {
"type": [
"boolean",
"null"
],
"description": "ignore highly similar keywords
optional field
if set to_true only core keywords will be returned, all highly similar keywords will be excluded;
default value: falsen"
},
"limit": {
"type": [
"integer",
"null"
],
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000"
},
"offset": {
"type": [
"integer",
"null"
],
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords"
},
"tag": {
"type": [
"string",
"null"
],
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response"
}
},
"example": [
{
"keyword": "computer mouse",
"language_name": "English",
"location_code": 2840,
"limit": 5,
"include_seed_keyword": true
}
]
}
]
},
"example": [
{
"keyword": "computer mouse",
"language_name": "English",
"location_code": 2840,
"limit": 5,
"include_seed_keyword": true
}
]
}
```
## Responses
### 200 — Successful operation
Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo"
}
]
}
```
### 400 — The request could not be processed. Check the request parameters.
### 401 — A valid Felo API key is required.
### 402 — The request cannot proceed because a billing requirement is not met.
### 403 — The account is not permitted to perform this operation.
### 429 — A request or spending limit has been reached.
### 502 — The service could not complete the request.
### 503 — The API or billing service is temporarily unavailable.
### 504 — The service timed out while processing the request.
### default — Error response; upstream passthrough responses may use provider formats
**application/json**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_AmazonKeywordData
`#/components/schemas/Response36Afe1097B20_AmazonKeywordData`
```json
{
"properties": {
"se_type": {
"type": [
"string",
"null"
],
"description": "search engine type"
},
"keyword": {
"type": [
"string",
"null"
],
"description": "related keyword"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "location code in a POST array",
"format": "int64"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "language code in a POST array"
},
"keyword_info": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordInfo"
}
],
"description": "keyword info for the returned keyword"
}
}
}
```
### Response36Afe1097B20_AmazonKeywordInfo
`#/components/schemas/Response36Afe1097B20_AmazonKeywordInfo`
```json
{
"properties": {
"se_type": {
"type": [
"string",
"null"
],
"description": "search engine type"
},
"last_updated_time": {
"type": [
"string",
"null"
],
"description": "date and time when keyword data was updated\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample: '2019-11-15 12:57:46 +00:00'"
},
"search_volume": {
"type": [
"integer",
"null"
],
"description": "average monthly search volume rate\nrepresents the (approximate) number of searches for the provided keyword idea on Amazon",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "the current version of the API"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "general status code\nyou can find the full list of the response codes here"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "general informational message\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "total execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array returned with an error",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "task identifier\nunique task identifier in our system in the UUID format"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "informational message of the task\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "number of elements in the result array",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "URL path"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "contains the same parameters that you specified in the POST request"
}
}
}
```
### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveItem
`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveItem`
```json
{
"type": "object",
"properties": {
"se_type": {
"type": [
"string",
"null"
],
"description": "search engine type"
},
"keyword_data": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordData"
}
],
"description": "keyword data for the returned keyword"
},
"depth": {
"type": [
"integer",
"null"
],
"description": "keyword search depth"
},
"related_keywords": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "list of related keywords
represents the list of search queries which are related to the keyword returned in the array above"
}
}
}
```
### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo"
}
]
},
"description": "array of tasks"
}
}
}
]
}
```
### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo
`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo`
```json
{
"type": "object",
"properties": {
"se_type": {
"type": [
"string",
"null"
],
"description": "search engine type"
},
"seed_keyword": {
"type": [
"string",
"null"
],
"description": "keyword in a POST array"
},
"seed_keyword_data": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordData"
}
],
"description": "keyword data for the seed keyword
fields in the object are identical to that of keyword_data"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "location code in a POST array"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "language code in a POST array"
},
"total_count": {
"type": [
"integer",
"null"
],
"description": "total amount of results in our database relevant to your request",
"format": "int64"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "the number of results returned in the items array",
"format": "int64"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveItem"
}
]
},
"description": "contains objects with keywords and related data"
}
}
}
```
### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo"
}
]
},
"description": "array of results"
}
}
}
]
}
```