SERP API Page Screenshot
Using the Live Page Screenshot endpoint, you can capture a screenshot of any SERP page.
The screenshot is made by visualizing the HTML of the search engine page. Thus, this endpoint can provide results for search engines that support HTML.
To obtain results, you have to specify task_id, which you can find in the response to the POST request.
Note: You can call the Page Screenshot endpoint any time within a 7-day period from the date of setting a task with a relevant Task POST endpoint. Importantly, once you call the Page Screenshot using a task ID, the URL to the page screenshot saved on the DataForSEO storage will only remain accessible for one day. Therefore, we highly recommend collecting the images from the task results and saving them on your storage on the same day you call the Page Screenshot endpoint.
If the image URL expires, you will have to make a new request the Page Screenshot endpoint (possible within a 7-day period from the date of setting a task with a relevant Task POST endpoint).
Your account will be charged for each request to this endpoint.
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array.
Description of the fields for setting a task:
| Field name |
Type |
Description |
task_id |
string |
task identifier
required field
unique identifier of the associated task in the UUID format
you will be able to use it within 7 days to request the results of the task at any time |
browser_preset |
string |
browser resolution preset
optional field
browser preset associated with a certain device type
can take the following values: desktop, tablet, mobile
note: by default, browser preset corresponds to the device type specified in the POST request
|
browser_screen_width |
integer |
width of the browser resolution
optional field
can be specified in the following range: 240-9999
|
browser_screen_height |
integer |
height of the browser resolution
optional field
can be specified in the following range: 240-9999
|
browser_screen_scale_factor |
float |
browser scale factor
optional field
can be specified in the following range: 0.5-3
|
page |
integer |
number of SERP pages
optional field
if depth in the corresponding Task POST request exceeds 100 results (or 1 SERP page), specify the number of SERP pages to screenshot;
default value: 1
|
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
Description of the fields in the results array:
| Field name |
Type |
Description |
version |
string |
the current version of the API |
status_code |
integer |
general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
status_message |
string |
general informational message
you can find the full list of general informational messages here |
time |
string |
execution time, seconds |
cost |
float |
total tasks cost, USD |
tasks_count |
integer |
the number of tasks in the tasks array |
tasks_error |
integer |
the number of tasks in the tasks array returned with an error |
tasks |
array |
array of tasks |
id |
string |
task identifier
unique task identifier in our system in the UUID format |
status_code |
integer |
status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here |
status_message |
string |
informational message of the task
you can find the full list of general informational messages here |
time |
string |
execution time, seconds |
cost |
float |
cost of the task, USD |
result_count |
integer |
number of elements in the result array |
path |
array |
URL path |
data |
object |
contains the same parameters that you specified in the POST request
|
result |
array |
array of results |
items_count |
integer |
number of items in the results array
|
items |
array |
items array
|
image |
string |
screenshot of the requested page
URL of the page screenshot on the DataForSEO storage
note: the page screenshot saved on the DataForSEO storage only remains accessible for one day after making the request |