Serp

Changed on

‌‌ Using the Live Page Screenshot endpoint, you can capture a screenshot of any SERP page.

post/v3/serp/screenshot

Request

  • Base URL: https://api.dataforseo.com
  • URL: https://api.dataforseo.com/v3/serp/screenshot
  • Auth: HTTP basic

Request body

task_idstring

<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format<br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time

browser_presetstring nullable

<em>browser resolution preset</em><br>optional field<br>browser preset associated with a certain device type<br>can take the following values: <code>desktop</code>, <code>tablet</code>, <code>mobile</code> <br><strong>Note:</strong> by default, browser preset corresponds to the device type specified in the POST request

browser_screen_widthinteger nullable

<em>width of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1920<br>default value for <code>mobile</code>: 390<br>default value for <code>table</code>: 1024

browser_screen_heightinteger nullable

<em>height of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1080<br>default value for <code>mobile</code>: 844<br>default value for <code>table</code>: 1366

browser_screen_scale_factornumber nullable

<em>browser scale factor</em><br>optional field<br>can be specified in the following range: <code>0.5-3</code><br>default value for <code>desktop</code>: 1<br>default value for <code>mobile</code>: 3<br>default value for <code>table</code>: 2

pageinteger nullable

<em>number of SERP pages</em><br>optional field<br>if <code>depth</code> in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot;<br>default value: <code>1</code>

Example request

[
  {
    "task_id": "06211235-0696-0139-1000-36727fbd3c90",
    "browser_screen_scale_factor": 0.5
  }
]

Response

Successful operation

versionstring nullable

the current version of the API

status_codeinteger nullable

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

status_messagestring nullable

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

timestring nullable

total execution time, seconds

costnumber double nullable

total tasks cost, USD

tasks_countinteger nullable

the number of tasks in the tasks array

tasks_errorinteger nullable

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

Changes