location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locationsLondon,England,United Kingdom"
},
"location_code": {
"type": "integer",
"description": "search engine location codelocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations2840"
},
"location_coordinate": {
"type": "string",
"description": "GPS coordinates of a locationlocation_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format52.6178549,-155.352142"
},
"language_name": {
"type": "string",
"description": "full name of search engine languagelanguage_codelanguage_codeEnglish, French, German"
},
"language_code": {
"type": "string",
"description": "search engine language codelanguage_namelanguage_nameen, fr, de"
},
"keywords_negative": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "keywords negative arrayall, mobile, desktop, tabletall"
},
"date_from": {
"type": [
"string",
"null"
],
"description": "starting date of the time rangefalse in the actual_data field, date_from can be set to the month before last and prior;true in the actual_data field, date_from can be set to the last month and prior;\"yyyy-mm-dd\"\"2020-01-01\"Note: we do not recommend using a custom time range for the past year's dates"
},
"date_to": {
"type": [
"string",
"null"
],
"description": "ending date of the time range
optional field
if you don't specify this field, data will be provided for the last 12 months;
minimum value: two years back from today’s date;
maximum value: one month from today's date;
note: we do not recommend using a custom time range for the past year's dates;
date format: \"yyyy-mm-dd\"
example:\"2020-03-15\"
Note: we do not recommend using a custom time range for the past year's dates"
},
"sort_by": {
"type": [
"string",
"null"
],
"description": "results sorting parameters
optional field
Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order
default value: relevance"
},
"search_partners": {
"type": [
"boolean",
"null"
],
"description": "Bing search partners type
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.
default value: false - results are returned for Bing, AOL, and Yahoo search networks"
},
"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": [
{
"language_code": "en",
"location_code": 2840,
"target": "dataforseo.com"
}
]
}
]
},
"example": [
{
"language_code": "en",
"location_code": 2840,
"target": "dataforseo.com"
}
]
}
```
## 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_KeywordsDataBingKeywordsForSiteLiveResponseInfo"
}
]
}
```
### 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_KeywordsDataBingKeywordsForSiteLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordsForSiteLiveResponseInfo`
```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_KeywordsDataBingKeywordsForSiteLiveTaskInfo"
}
]
},
"description": "array of tasks"
}
}
}
]
}
```
### Response36Afe1097B20_KeywordsDataBingKeywordsForSiteLiveResultInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordsForSiteLiveResultInfo`
```json
{
"type": "object",
"properties": {
"keyword": {
"type": [
"string",
"null"
],
"description": "keyword in a POST array"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "location code in a POST array"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "language code in a POST array"
},
"search_partners": {
"type": [
"boolean",
"null"
],
"description": "indicates whether data from partner networks included in the response"
},
"device": {
"type": [
"string",
"null"
],
"description": "device type in a POST array
if there is no data, then the value is_nulln"
},
"competition": {
"type": [
"number",
"null"
],
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.
Possible values: 0.1, 0.5,0.90.1 - low competition,0.5 - medium competition,0.9 - high competition;
if there is no data the value is null"
},
"cpc": {
"type": [
"number",
"null"
],
"description": "cost-per-click
represents the average cost per click (USD) historically paid for the keyword.
if there is no data, then the value is_nulln"
},
"search_volume": {
"type": [
"integer",
"null"
],
"description": "monthly average search volume rate
represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targetingsearch volume is rounded to the closest decimal valuesif there is no data, then the value is_nulln",
"format": "int64"
},
"categories": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "product and service categories
legacy field, the value will always be null"
},
"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 (as available for the past twelve months), targeted to the specified geographic locations.
if there is no data, then the value is_nulln"
}
}
}
```
### Response36Afe1097B20_KeywordsDataBingKeywordsForSiteLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordsForSiteLiveTaskInfo`
```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_KeywordsDataBingKeywordsForSiteLiveResultInfo"
}
]
},
"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"
}
}
}
```