learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
},
"location_name": {
"type": [
"string",
"null"
],
"description": "full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_coordinate;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840"
},
"location_coordinate": {
"type": [
"string",
"null"
],
"description": "GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_code;location_coordinate parameter should be specified in the \"latitude,longitude\" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142"
},
"language_name": {
"type": [
"string",
"null"
],
"description": "full name of search engine language
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "search engine language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en"
},
"search_partners": {
"type": [
"boolean",
"null"
],
"description": "include Google search partners
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;
default value: false - results are returned for Google search sites"
},
"date_from": {
"type": [
"string",
"null"
],
"description": "starting date of the time range
optional field
date format: \"yyyy-mm-dd\"
minimal value: 4 years from the current date
by default, data is returned for the past 12 months;
Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior"
},
"date_to": {
"type": [
"string",
"null"
],
"description": "ending date of the time range
optional field
Note: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;
if you don't specify this field, yesterday's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2022-11-30\""
},
"include_adult_keywords": {
"type": [
"boolean",
"null"
],
"description": "include keywords associated with adult content
optional field
if set to_true, adult keywords will be included in the response
default value:_false
note_that the API may return no data for such keywords due to_Google Ads restrictionsn"
},
"sort_by": {
"type": [
"string",
"null"
],
"description": "results sorting parameters
optional field
use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order
default value: relevance"
},
"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 array of the response"
}
},
"example": [
{
"location_code": 2840,
"keywords": [
"buy laptop",
"cheap laptops for sale",
"purchase laptop"
],
"date_from": "2021-08-01",
"search_partners": true
}
]
}
]
},
"example": [
{
"location_code": 2840,
"keywords": [
"buy laptop",
"cheap laptops for sale",
"purchase laptop"
],
"date_from": "2021-08-01",
"search_partners": 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_KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo"
}
]
}
```
### 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_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_KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo`
```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_KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo"
}
]
},
"description": "array of tasks"
}
}
}
]
}
```
### Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveResultInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveResultInfo`
```json
{
"type": "object",
"properties": {
"keyword": {
"type": [
"string",
"null"
],
"description": "keyword
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)"
},
"spell": {
"type": [
"string",
"null"
],
"description": "correct spelling of the keyword
Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;
we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "location code in a POST array
if there is no data, then the value is_nulln"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "language code in a POST array
if there is no data, then the value is_nulln"
},
"search_partners": {
"type": [
"boolean",
"null"
],
"description": "indicates whether data from partner networks included in the response"
},
"competition": {
"type": [
"string",
"null"
],
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only;
this value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW;
if there is no data the value is null;
learn more about the metric in this help center article"
},
"competition_index": {
"type": [
"integer",
"null"
],
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only;
this value is based on Google Ads data and can be between 0 and 100 (inclusive);
if there is no data the value is null;
learn more about the metric in this help center article"
},
"search_volume": {
"type": [
"integer",
"null"
],
"description": "monthly average search volume rate;
represents either the (approximate) number of searches for the given keyword idea on google.com or google.com and partners, depending on the user’s targeting;
if there is no data then the value is_nulln",
"format": "int64"
},
"low_top_of_page_bid": {
"type": [
"number",
"null"
],
"description": "minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);
the value may differ depending on the location specified in a POST request"
},
"high_top_of_page_bid": {
"type": [
"number",
"null"
],
"description": "maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);
the value may differ depending on the location specified in a POST request"
},
"cpc": {
"type": [
"number",
"null"
],
"description": "cost per click
indicates the amount paid (USD) for each click on the ad displayed for a given keyword"
},
"monthly_searches": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo"
}
]
},
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months by default), targeted to the specified geographic locations;
if there is no data then the value is_nulln"
}
}
}
```
### Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo`
```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_KeywordsDataGoogleAdsSearchVolumeLiveResultInfo"
}
]
},
"description": "array of results"
}
}
}
]
}
```
### Response36Afe1097B20_MonthlySearchesInfo
`#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo`
```json
{
"type": "object",
"properties": {
"year": {
"type": [
"integer",
"null"
],
"description": "year"
},
"month": {
"type": [
"integer",
"null"
],
"description": "month"
},
"search_volume": {
"type": [
"integer",
"null"
],
"description": "monthly average search volume rate"
}
}
}
```