Skip to main content
POST
Setting Google Organic SERP Tasks

Authorizations

Authorization
string
header
required

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

Body

application/json
keyword
string
required

Keyword to search for

location_name
string

Full name of search engine location

location_code
integer

Search engine location code

location_coordinate
string

GPS coordinates of a location

language_name
string

Full name of search engine language

language_code
string

Search engine language code

depth
integer

Parsing depth, default 100, max 700

max_crawl_pages
integer

Page crawl limit, max 100

device
string

Device type: desktop or mobile

os
string

Device operating system

group_organic_results
boolean

Display related results as grouped organic results

calculate_rectangles
boolean

Calculate pixel rankings for SERP elements in advanced results

postback_url
string

Postback URL for completed task results

pingback_url
string

Pingback URL for task completion notification

postback_data
string

Postback payload type

tag
string

User-defined task identifier

Response

Successful response

version
string

API version

status_code
integer

General status code

status_message
string

General informational message

time
string

Execution time

cost
number

Total tasks cost in USD

tasks_count
integer

Number of tasks in the request

tasks_error
integer

Number of tasks returned with an error

tasks
string

Array of task objects

tasks[].id
string

Task identifier in UUID format

tasks[].status_code
integer

Task status code

tasks[].status_message
string

Task status message

tasks[].cost
number

Task cost

tasks[].result_count
integer

Number of result elements