keyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”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 search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:London,England,United Kingdom"
},
"location_code": {
"type": "integer",
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:2840"
},
"language_name": {
"type": "string",
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:Czech"
},
"language_code": {
"type": "string",
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:csn"
},
"url": {
"type": [
"string",
"null"
],
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields;
note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL;
in most cases, we wouldn’t recommend using this method."
},
"priority": {
"type": [
"integer",
"null"
],
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priority
You will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page."
},
"depth": {
"type": [
"integer",
"null"
],
"description": "parsing depth
optional field
number of results in SERP
default value: 10;
maximum value: 500;
Your account will be billed per each SERP containing up to 10 results;
Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;
The cost can be calculated on the Pricing page."
},
"max_crawl_pages": {
"type": [
"integer",
"null"
],
"description": "page crawl limit
optional field
number of search results pages to crawl
default value: 1
max value: 10
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center"
},
"device": {
"type": [
"string",
"null"
],
"description": "device type
optional field
return results for a specific device type
can take the values:desktop, mobile
default value: desktop"
},
"os": {
"type": [
"string",
"null"
],
"description": "device operating system
optional field
if you specify desktop in the device field, choose from the following values: windows, macos
default value: windows
if you specify mobile in the device field, choose from the following values: android, ios
default value: android"
},
"se_domain": {
"type": [
"string",
"null"
],
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically
however, you can set a custom search engine domain in this field
example:
optional field"
},
"calculate_rectangles": {
"type": [
"boolean",
"null"
],
"description": "calculate pixel rankings for SERP elements in advanced results
optional field
pixel ranking refers to the distance between the result snippet and top left corner of the screen;
Visit Help Center to learn more>>
by default, the parameter is set to false
Note: if set to true, the charge per task will be multiplied by 2"
},
"stop_crawl_on_match": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"type": "object",
"properties": {
"match_value": {
"type": [
"string",
"null"
],
"description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com"
},
"match_type": {
"type": [
"string",
"null"
],
"description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard"
}
}
}
]
},
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
},
"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"
},
"postback_url": {
"type": [
"string",
"null"
],
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center"
},
"postback_data": {
"type": "string",
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the function you used for setting a task
possible values:regular, advanced, html"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center"
}
},
"example": [
{
"language_code": "cs",
"location_code": 2203,
"keyword": "albert einstein"
}
]
}
]
},
"example": [
{
"language_code": "cs",
"location_code": 2203,
"keyword": "albert einstein"
}
]
}
```
## 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_SerpSeznamOrganicTaskPostResponseInfo"
}
]
}
```
### 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_SerpSeznamOrganicTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_SerpSeznamOrganicTaskPostResponseInfo`
```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_SerpSeznamOrganicTaskPostTaskInfo"
}
]
},
"description": "array of tasks"
}
}
}
]
}
```
### Response36Afe1097B20_SerpSeznamOrganicTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_SerpSeznamOrganicTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"object",
"null"
],
"description": "array of results
in this case, the value will be null"
}
}
}
]
}
```