Skip to main content
POST
Reference example
Queues the advertisers matching a query in Google’s ads transparency data on Google, returning a task id in tasks[0].id. The charge lands here; fetching is free, including re-fetching. Wrapped in DataForSEO’s envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The live twin answers immediately and is simpler for a single query; queue when the batch would outlast a tool call.

Example

Cost and request rules

Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.
  • Default request reference estimate (USD): 0.02
  • Cost contract: response_usd
  • Published reference multiplier: 1.0
  • Settlement evidence source: response_body

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
keyword
string

keyword

required field

you can specify up to 700 characters in the keyword field

all %## will be decoded (plus character ‘+’ will be decoded to a space character)

if you need to use the “%” character for your keyword, please specify it as “%25”;

if you need to use the “+” character for your 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

priority
integer | null

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.

location_code
integer | null

search engine location code

optional field

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 the https://api.dataforseo.com/v3/serp/google/ads_advertisers/locations

example:

2840


Note: if you don't specify location_name, location_code, or location_coordinate, advertisers will be searched across all the available locations

pingback_url
string | null

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=$id

http://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

postback_url
string | null

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=$id

http://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
string

postback_url datatype

required field if you specify postback_url

corresponds to the function you used for setting a task

possible values:

advanced

location_name
string | null

full name of search engine location

optional field

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 the https://api.dataforseo.com/v3/serp/google/ads_advertisers/locations

example:

London,England,United Kingdom


Note: if you don't specify location_name, location_code, or location_coordinate, advertisers will be searched across all the available locations

location_coordinate
string | null

GPS coordinates of a location

optional field

if you use this field, you don't need to specify location_name or location_code

example:

52.6178549,-155.352142


Note: if you don't specify location_name, location_code, or location_coordinate, advertisers will be searched across all the available locations

tag
string | null

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:

Response

object | null

Successful operation

version
string | null

the current version of the API

status_code
integer | null

general status code you can find the full list of the response codes here

status_message
string | null

general informational message you can find the full list of general informational messages here

time
string | null

total execution time, seconds

cost
number<double> | null

total tasks cost, USD

tasks_count
integer<int64> | null

the number of tasks in the tasks array

tasks_error
integer<int64> | null

the number of tasks in the tasks array returned with an error

tasks
(object | null)[] | null

array of tasks