{"id":13891,"date":"2022-05-09T11:52:38","date_gmt":"2022-05-09T11:52:38","guid":{"rendered":"https:\/\/docs_v3.dataforseo.com\/v3\/?page_id=13891"},"modified":"2026-08-11T14:11:24","modified_gmt":"2026-08-11T14:11:24","slug":"on_page-page_screenshot","status":"publish","type":"page","link":"https:\/\/docs.dataforseo.com\/v3\/on_page-page_screenshot\/","title":{"rendered":"on_page\/page_screenshot"},"content":{"rendered":"<div class=\"wpb-content-wrapper\"><p>[vc_row][vc_column][vc_column_text]<\/p>\n<h2 id=\"setting-serp-tasks\">OnPage API Page Screenshot<\/h2>\n<p>\u200c\u200c<br \/>\nUsing this endpoint, you can capture a full high-quality screenshot of any webpage. In this way, you can review the target page as the DataForSEO crawler and Googlebot see it.<\/p>\n<p>Your account will be charged per each page screenshot. <\/p>\n<p>[\/vc_column_text]    <div class=\"endpoint\">\n        <img decoding=\"async\" class=\"endpoint__icon\" src=\"https:\/\/docs.dataforseo.com\/v3\/wp-content\/themes\/dataforseo\/assets\/img\/icons\/checked-circle.svg\" alt=\"checked\">\n\n                    POST            <button class=\"btn-reset button-link copy-button\" data-href=\"https:\/\/api.dataforseo.com\/v3\/on_page\/page_screenshot\">\n                https:\/\/api.dataforseo.com\/v3\/on_page\/page_screenshot                <svg width=\"16\" height=\"16\" viewBox=\"0 0 16 16\">\n                    <use href=\"https:\/\/docs.dataforseo.com\/v3\/wp-content\/themes\/dataforseo\/assets\/img\/icons\/sprite.svg#layers\"><\/use>\n                <\/svg>\n            <\/button>\n            <\/div>\n    \t<article class=\"info-card info-card--yellow\">\n\t\t<header class=\"info-card__header\">\n\t\t\t<div class=\"info-card__icon\">\n\t\t\t\t<svg width=\"16\" height=\"16\" viewBox=\"0 0 16 16\">\n\t\t\t\t\t<use href=\"https:\/\/docs.dataforseo.com\/v3\/wp-content\/themes\/dataforseo\/assets\/img\/icons\/sprite.svg#label\"><\/use>\n\t\t\t\t<\/svg>\n\t\t\t<\/div>\n\t\t\t<div class=\"info-card__title\">Pricing<\/div>\n\t\t<\/header>\n\t\t<div class=\"info-card__content\">\n\t\t\t<p>  Your account will be charged for each request.<br \/>\nThe cost can be calculated on the <a title=\"Pricing\" href=\"https:\/\/dataforseo.com\/pricing\/on-page\/onpage-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing<\/a> page.<\/p>\n\t\t<\/div>\n\t<\/article>\n\t[vc_column_text]All POST data should be sent in the <a href=\"https:\/\/en.wikipedia.org\/wiki\/JSON\">JSON<\/a> 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.<\/p>\n<p><strong>You can send up to 2000 API requests per minute, with each request containing no more than 20 tasks. The maximum number of simultaneous requests you can send is limited to 30.<\/strong><\/p>\n<p><strong>Description of the fields for setting a task:<\/strong><br \/>\n<div class=\"dfs-doc-container dfs-doc-request\"><table><thead><tr><th>Field name<\/th><th>Type<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr data-doc-id=\"url\"><td><code>url<\/code><\/td><td>string<\/td><td><p><em>page url<\/em><br><strong>required field<\/strong><br>absolute URL of the page to snap<br><strong>note:<\/strong> if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain <code>\"error_message\":\"Screenshot is empty\"<\/code> in the response array<\/p><\/td><\/tr><tr data-doc-id=\"accept_language\"><td><code>accept_language<\/code><\/td><td>string<\/td><td><p><em>language header for accessing the website<\/em><br>optional field<br>all locale formats are supported (xx, xx-XX, xxx-XX, etc.)<br><strong>note:<\/strong> if you do not specify this parameter, some websites may deny access; in this case, you will obtain <code>\"error_message\":\"Screenshot is empty\"<\/code> in the response array<\/p><\/td><\/tr><tr data-doc-id=\"custom_user_agent\"><td><code>custom_user_agent<\/code><\/td><td>string<\/td><td><p><em>custom user agent<\/em><br>optional field<br>custom user agent for crawling a website<br>example: <code>Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/83.0.4103.116 Safari\/537.36<br><\/code><br>default value: <code>Mozilla\/5.0 (compatible; RSiteAuditor)<\/code><\/p><\/td><\/tr><tr data-doc-id=\"browser_preset\"><td><code>browser_preset<\/code><\/td><td>string<\/td><td><p><em>preset for browser screen parameters<\/em><br>optional field<br>if you use this field, you don't need to indicate <code>browser_screen_width<\/code>, <code>browser_screen_height<\/code>, <code>browser_screen_scale_factor<\/code><p>possible values:<br><code>desktop<\/code>, <code>mobile<\/code>, <code>tablet<\/code><p><code>desktop<\/code> preset will apply the following values:<p><code>browser_screen_width: 1920<\/code><br><code>browser_screen_height: 1080<\/code><br><code>browser_screen_scale_factor: 1<\/code><p><code>mobile<\/code> preset will apply the following values:<p><code>browser_screen_width: 390<\/code><br><code>browser_screen_height: 844<\/code><br><code>browser_screen_scale_factor: 3<\/code><p><code>tablet<\/code> preset will apply the following values:<p><code>browser_screen_width: 1024<\/code><br><code>browser_screen_height: 1366<\/code><br><code>browser_screen_scale_factor: 2<\/code><p><strong>Note:<\/strong> in this endpoint, the <code>enable_browser_rendering<\/code>, <code>enable_javascript<\/code>, <code>load_resources<\/code>, and <code>enable_xhr<\/code> parameters are always enabled.<\/p><\/td><\/tr><tr data-doc-id=\"browser_screen_width\"><td><code>browser_screen_width<\/code><\/td><td>integer<\/td><td><p><em>browser screen width<\/em><br>optional field<br>you can set a custom browser screen width to perform audit for a particular device;<br>if you use this field, you don't need to indicate <code>browser_preset<\/code> as it will be ignored;<p>minimum value, in pixels: <code>240<\/code> <br>maximum value, in pixels: <code>9999<\/code><\/p><\/td><\/tr><tr data-doc-id=\"browser_screen_height\"><td><code>browser_screen_height<\/code><\/td><td>integer<\/td><td><p><em>browser screen height<\/em><br>optional field<br>you can set a custom browser screen height to perform audit for a particular device;<br>if you use this field, you don't need to indicate <code>browser_preset<\/code> as it will be ignored;<p>minimum value, in pixels: <code>240<\/code> <br>maximum value, in pixels: <code>9999<\/code><\/p><\/td><\/tr><tr data-doc-id=\"browser_screen_scale_factor\"><td><code>browser_screen_scale_factor<\/code><\/td><td>float<\/td><td><p><em>browser screen scale factor<\/em><br>optional field<br>you can set a custom browser screen resolution ratio to perform audit for a particular device;<br>if you use this field, you don't need to indicate <code>browser_preset<\/code> as it will be ignored;<p>minimum value: <code>0.5<\/code> <br>maximum value: <code>3<\/code><\/p><\/td><\/tr><tr data-doc-id=\"full_page_screenshot\"><td><code>full_page_screenshot<\/code><\/td><td>boolean<\/td><td><p><em>take a screenshot of the full page<\/em><br>optional field<br>set to <code>false<\/code> if you want to capture only the part of the page displayed before scrolling<br>default value: <code>true<\/code><\/p><\/td><\/tr><tr data-doc-id=\"disable_cookie_popup\"><td><code>disable_cookie_popup<\/code><\/td><td>boolean<\/td><td><p><em>disable the cookie popup <\/em><br>optional field<br>set to <code>true<\/code> if you want to disable the popup requesting cookie consent from the user;<br>default value: <br><code>false<\/code><\/p><\/td><\/tr><tr data-doc-id=\"switch_pool\"><td><code>switch_pool<\/code><\/td><td>boolean<\/td><td><p><em>switch proxy pool<\/em><br>optional field<br>if <code>true<\/code>, additional proxy pools will be used to obtain the requested data;<br>the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional <code>rate-limit<\/code> and\/or <code>site_unreachable<\/code> errors<\/p><\/td><\/tr><tr data-doc-id=\"ip_pool_for_scan\"><td><code>ip_pool_for_scan<\/code><\/td><td>string<\/td><td><p><em>proxy pool<\/em><br>optional field<br>you can choose a location of the proxy pool that will be used to obtain the requested data;<br>the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional <code>site_unreachable<\/code> errors<br>possible values: <code>us<\/code>, <code>de<\/code><\/p><\/td><\/tr><\/tbody><\/table><\/div>\n<p>As a response of the API server, you will receive <a href=\"https:\/\/en.wikipedia.org\/wiki\/JSON\">JSON<\/a>-encoded data containing a <code>tasks<\/code> array with the information specific to the set tasks.<\/p>\n<p><strong>Description of the fields in the results array:<\/strong><br \/>\n<div class=\"dfs-doc-container dfs-doc-response\"><div class=\"api-block-main\"><div class=\"api-section\"><table><thead><tr><th>Field name<\/th><th>Type<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr data-doc-id=\"version\"><td><code>version<\/code><\/td><td>string<\/td><td><p><em>the current version of the API<\/em><\/p><\/td><\/tr><tr data-doc-id=\"status_code\"><td><code>status_code<\/code><\/td><td>integer<\/td><td><p><i>general status code<\/i><br>you can find the full list of the response codes <a href=\"\/v3\/appendix\/errors\">here<\/a><br><strong>Note:<\/strong> we strongly recommend designing a necessary system for handling related exceptional or error conditions<\/p><\/td><\/tr><tr data-doc-id=\"status_message\"><td><code>status_message<\/code><\/td><td>string<\/td><td><p><em>general informational message<\/em><br>you can find the full list of general informational messages <a href=\"\/v3\/appendix\/errors\">here<\/a><\/p><\/td><\/tr><tr data-doc-id=\"time\"><td><code>time<\/code><\/td><td>string<\/td><td><p><em>execution time, seconds<\/em><\/p><\/td><\/tr><tr data-doc-id=\"cost\"><td><code>cost<\/code><\/td><td>float<\/td><td><p><em>total <i>tasks<\/i> cost, USD<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks_count\"><td><code>tasks_count<\/code><\/td><td>integer<\/td><td><p><em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks_error\"><td><code>tasks_error<\/code><\/td><td>integer<\/td><td><p><em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array returned with an error<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks\"><td><strong><code>tasks<\/code><\/strong><\/td><td>array<\/td><td><p><em>array of tasks<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-id\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>id<\/code><\/td><td>string<\/td><td><p><em>task identifier<\/em><br><strong>unique task identifier in our system in the <a href=\"https:\/\/en.wikipedia.org\/wiki\/Universally_unique_identifier\">UUID<\/a> format<\/strong><\/p><\/td><\/tr><tr data-doc-id=\"tasks-status_code\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>status_code<\/code><\/td><td>integer<\/td><td><p><em>status code of the task<\/em><br>generated by DataForSEO; can be within the following range: 10000-60000<br>you can find the full list of the response codes <a href=\"\/v3\/appendix\/errors\">here<\/a><\/p><\/td><\/tr><tr data-doc-id=\"tasks-status_message\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>status_message<\/code><\/td><td>string<\/td><td><p><em>informational message of the task<\/em><br>you can find the full list of general informational messages <a href=\"\/v3\/appendix\/errors\">here<\/a><\/p><\/td><\/tr><tr data-doc-id=\"tasks-time\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>time<\/code><\/td><td>string<\/td><td><p><em>execution time, seconds<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-cost\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>cost<\/code><\/td><td>float<\/td><td><p><em>cost of the task, USD<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result_count\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>result_count<\/code><\/td><td>integer<\/td><td><p><em>number of elements in the <code>result<\/code> array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-path\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>path<\/code><\/td><td>array<\/td><td><p><em>URL path<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-data\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>data<\/code><\/td><td>object<\/td><td><p><em>contains the same parameters that you specified in the POST request<br><\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<strong><code>result<\/code><\/strong><\/td><td>array<\/td><td><p><em>array of results<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-crawl_progress\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>crawl_progress<\/code><\/td><td>string<\/td><td><p><em>status of the crawling session<\/em><br>possible values: <code>in_progress<\/code>, <code>finished<\/code><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-error_message\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>error_message<\/code><\/td><td>string<\/td><td><p><em>error message<\/em><br>if the <code>url<\/code> you indicated returns a 404 status code or is not a valid URL, you will obtain <code>\"error_message\":\"Screenshot is empty\"<\/code><br>if no error is encountered, the value will be <code>null<\/code><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items_count\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>items_count<\/code><\/td><td>integer<\/td><td><p><em>number of items in the results array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong><code>items<\/code><\/strong><\/td><td>array<\/td><td><p><em>items array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-image\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>image<\/code><\/td><td>string<\/td><td><p><em>screenshot of the requested page<\/em><br>URL of the page screenshot on the DataForSEO storage<\/p><\/td><\/tr><\/tbody><\/table><\/div><\/div><\/div><br \/>\n\u200c\u200c[\/vc_column_text][\/vc_column][\/vc_row]<\/p>\n<blockquote><p>Instead of \u2018login\u2019 and \u2018password\u2019 use your credentials from https:\/\/app.dataforseo.com\/api-access<\/p><\/blockquote><div id=\"curl\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-bash hljs\"># Instead of &#039;login&#039; and &#039;password&#039; use your credentials from https:\/\/app.dataforseo.com\/api-access \r\nlogin=&quot;login&quot; \r\npassword=&quot;password&quot; \r\ncred=&quot;$(printf ${login}:${password} | base64)&quot; \r\ncurl --location --request POST &quot;https:\/\/api.dataforseo.com\/v3\/on_page\/page_screenshot&quot; \r\n--header &quot;Authorization: Basic ${cred}&quot;  \r\n--header &quot;Content-Type: application\/json&quot; \r\n--data-raw &#039;[\r\n  {\r\n    &quot;url&quot;: &quot;https:\/\/dataforseo.com\/apis&quot;\r\n  }\r\n]&#039;<\/code><\/pre><\/div><\/div><div id=\"php\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-php hljs\">&lt;?php\r\n\/\/ You can download this file from here https:\/\/cdn.dataforseo.com\/v3\/examples\/php\/php_RestClient.zip\r\nrequire(&#039;RestClient.php&#039;);\r\n$api_url = &#039;https:\/\/api.dataforseo.com\/&#039;;\r\n\/\/ Instead of &#039;login&#039; and &#039;password&#039; use your credentials from https:\/\/app.dataforseo.com\/api-access\r\n$client = new RestClient($api_url, null, &#039;login&#039;, &#039;password&#039;);\r\n\r\n$post_array = array();\r\n\/\/ simple way to get a result\r\n$post_array[] = array(\r\n   &quot;url&quot; =&gt; &quot;https:\/\/dataforseo.com\/apis&quot;\r\n);\r\ntry {\r\n   \/\/ POST \/v3\/on_page\/page_screenshot\r\n   \/\/ the full list of possible parameters is available in documentation\r\n   $result = $client-&gt;post(&#039;\/v3\/on_page\/page_screenshot&#039;, $post_array);\r\n   print_r($result);\r\n   \/\/ do something with post result\r\n} catch (RestClientException $e) {\r\n   echo &quot;n&quot;;\r\n   print &quot;HTTP code: {$e-&gt;getHttpCode()}n&quot;;\r\n   print &quot;Error code: {$e-&gt;getCode()}n&quot;;\r\n   print &quot;Message: {$e-&gt;getMessage()}n&quot;;\r\n   print  $e-&gt;getTraceAsString();\r\n   echo &quot;n&quot;;\r\n}\r\n\r\n$client = null;\r\n?&gt;<\/code><\/pre><\/div><\/div><div id=\"javascript\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-javascript hljs\">const post_array = [];\r\n\r\npost_array.push({\r\n  &quot;url&quot;: &quot;https:\/\/dataforseo.com\/apis&quot;\r\n});\r\n\r\nconst axios = require(&#039;axios&#039;);\r\n\r\naxios({\r\n  method: &#039;post&#039;,\r\n  url: &#039;https:\/\/api.dataforseo.com\/v3\/on_page\/page_screenshot&#039;,\r\n  auth: {\r\n    username: &#039;login&#039;,\r\n    password: &#039;password&#039;\r\n  },\r\n  data: post_array,\r\n  headers: {\r\n    &#039;content-type&#039;: &#039;application\/json&#039;\r\n  }\r\n}).then(function (response) {\r\n  var result = response[&#039;data&#039;][&#039;tasks&#039;];\r\n  \/\/ Result data\r\n  console.log(result);\r\n}).catch(function (error) {\r\n  console.log(error);\r\n});<\/code><\/pre><\/div><\/div><div id=\"python\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-python hljs\">from random import Random\r\nfrom client import RestClient\r\n# You can download this file from here https:\/\/api.dataforseo.com\/v3\/_examples\/python\/_python_Client.zip\r\nclient = RestClient(&quot;login&quot;, &quot;password&quot;)\r\n\r\npost_data = dict()\r\n# simple way to get a result\r\npost_data[len(post_data)] = dict(\r\n    url=&quot;https:\/\/dataforseo.com\/apis&quot;\r\n)\r\n# POST \/v3\/on_page\/page_screenshot\r\n# the full list of possible parameters is available in documentation\r\nresponse = client.post(&quot;\/v3\/on_page\/page_screenshot&quot;, post_data)\r\n# you can find the full list of the response codes here https:\/\/docs.dataforseo.com\/v3\/appendix\/errors\r\nif response[&quot;status_code&quot;] == 20000:\r\n    print(response)\r\n    # do something with result\r\nelse:\r\n    print(&quot;error. Code: %d Message: %s&quot; % (response[&quot;status_code&quot;], response[&quot;status_message&quot;]))<\/code><\/pre><\/div><\/div><div id=\"csharp\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-csharp hljs\">using Newtonsoft.Json;\r\nusing System;\r\nusing System.Collections.Generic;\r\nusing System.Net.Http;\r\nusing System.Net.Http.Headers;\r\nusing System.Text;\r\nusing System.Threading.Tasks;\r\n\r\nnamespace DataForSeoDemos\r\n{\r\n    public static partial class Demos\r\n    {\r\n        public static async Task on_page_page_screenshot()\r\n        {\r\n            var httpClient = new HttpClient\r\n            {\r\n                BaseAddress = new Uri(&quot;https:\/\/api.dataforseo.com\/&quot;),\r\n                \/\/ Instead of &#039;login&#039; and &#039;password&#039; use your credentials from https:\/\/app.dataforseo.com\/api-access\r\n                DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue(&quot;Basic&quot;, Convert.ToBase64String(Encoding.ASCII.GetBytes(&quot;login:password&quot;))) }\r\n            };\r\n            var postData = new List&lt;object&gt;();\r\n            \/\/ simple way to get a result\r\n            postData.Add(new\r\n            {\r\n                url = &quot;https:\/\/dataforseo.com\/apis&quot;\r\n            });\r\n            \/\/ POST \/v3\/on_page\/page_screenshot\r\n            \/\/ the full list of possible parameters is available in documentation\r\n            var taskPostResponse = await httpClient.PostAsync(&quot;\/v3\/on_page\/page_screenshot&quot;, new StringContent(JsonConvert.SerializeObject(postData)));\r\n            var result = JsonConvert.DeserializeObject&lt;dynamic&gt;(await taskPostResponse.Content.ReadAsStringAsync());\r\n            \/\/ you can find the full list of the response codes here https:\/\/docs.dataforseo.com\/v3\/appendix\/errors\r\n            if (result.status_code == 20000)\r\n            {\r\n                \/\/ do something with result\r\n                Console.WriteLine(result);\r\n            }\r\n            else\r\n                Console.WriteLine($&quot;error. Code: {result.status_code} Message: {result.status_message}&quot;);\r\n        }\r\n    }\r\n}<\/code><\/pre><\/div><\/div><blockquote><p>The above command returns JSON structured like this:<\/p><\/blockquote><div class=\"example example--json\"><div class=\"example__content\"><div class=\"example__code example__code-json\"><pre><code class=\"language-json hljs\">{\r\n    &quot;version&quot;: &quot;0.1.20220428&quot;,\r\n    &quot;status_code&quot;: 20000,\r\n    &quot;status_message&quot;: &quot;Ok.&quot;,\r\n    &quot;time&quot;: &quot;6.3639 sec.&quot;,\r\n    &quot;cost&quot;: 0.004,\r\n    &quot;tasks_count&quot;: 1,\r\n    &quot;tasks_error&quot;: 0,\r\n    &quot;tasks&quot;: [\r\n        {\r\n            &quot;id&quot;: &quot;05061850-1535-0444-0000-698f746278b6&quot;,\r\n            &quot;status_code&quot;: 20000,\r\n            &quot;status_message&quot;: &quot;Ok.&quot;,\r\n            &quot;time&quot;: &quot;6.3053 sec.&quot;,\r\n            &quot;cost&quot;: 0.004,\r\n            &quot;result_count&quot;: 1,\r\n            &quot;path&quot;: [\r\n                &quot;v3&quot;,\r\n                &quot;on_page&quot;,\r\n                &quot;page_screenshot&quot;\r\n            ],\r\n            &quot;data&quot;: {\r\n                &quot;api&quot;: &quot;on_page&quot;,\r\n                &quot;function&quot;: &quot;page_screenshot&quot;,\r\n                &quot;url&quot;: &quot;https:\/\/dataforseo.com\/apis&quot;\r\n            },\r\n            &quot;result&quot;: [\r\n                {\r\n                    &quot;crawl_progress&quot;: &quot;finished&quot;,\r\n                    &quot;error_message&quot;: null,\r\n                    &quot;items_count&quot;: 1,\r\n                    &quot;items&quot;: [\r\n                        {\r\n                            &quot;image&quot;: &quot;https:\/\/api.dataforseo.com\/cdn\/screenshot\/05061850-1535-0444-0000-698f746278b6&quot;\r\n                        }\r\n                    ]\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}<\/code><\/pre><\/div><\/div><\/div><\/div>","protected":false},"excerpt":{"rendered":"<p>[vc_row][vc_column][vc_column_text] OnPage API Page Screenshot \u200c\u200c Using this endpoint, you can capture a full high-quality screenshot of any webpage. In this way, you can review the target page as the DataForSEO crawler and Googlebot see it. Your account will be charged per each page screenshot. [\/vc_column_text] POST https:\/\/api.dataforseo.com\/v3\/on_page\/page_screenshot Pricing Your account will be charged for [&hellip;]<\/p>\n","protected":false},"author":17,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"template.php","meta":{"apibase_doc_request_yaml":"parameters:\n  - name: url\n    type: string\n    description: |\n      <em>page url<\/em><br><strong>required field<\/strong><br>absolute URL of the page to snap<br><strong>note:<\/strong> if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain <code>\"error_message\":\"Screenshot is empty\"<\/code> in the response array\n  - name: accept_language\n    type: string\n    description: |\n      <em>language header for accessing the website<\/em><br>optional field<br>all locale formats are supported (xx, xx-XX, xxx-XX, etc.)<br><strong>note:<\/strong> if you do not specify this parameter, some websites may deny access; in this case, you will obtain <code>\"error_message\":\"Screenshot is empty\"<\/code> in the response array\n  - name: custom_user_agent\n    type: string\n    description: |\n      <em>custom user agent<\/em><br>optional field<br>custom user agent for crawling a website<br>example: <code>Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/83.0.4103.116 Safari\/537.36<br><\/code><br>default value: <code>Mozilla\/5.0 (compatible; RSiteAuditor)<\/code>\n  - name: browser_preset\n    type: string\n    description: |\n      <em>preset for browser screen parameters<\/em><br>optional field<br>if you use this field, you don't need to indicate <code>browser_screen_width<\/code>, <code>browser_screen_height<\/code>, <code>browser_screen_scale_factor<\/code><p>possible values:<br><code>desktop<\/code>, <code>mobile<\/code>, <code>tablet<\/code><p><code>desktop<\/code> preset will apply the following values:<p><code>browser_screen_width: 1920<\/code><br><code>browser_screen_height: 1080<\/code><br><code>browser_screen_scale_factor: 1<\/code><p><code>mobile<\/code> preset will apply the following values:<p><code>browser_screen_width: 390<\/code><br><code>browser_screen_height: 844<\/code><br><code>browser_screen_scale_factor: 3<\/code><p><code>tablet<\/code> preset will apply the following values:<p><code>browser_screen_width: 1024<\/code><br><code>browser_screen_height: 1366<\/code><br><code>browser_screen_scale_factor: 2<\/code><p><strong>Note:<\/strong> in this endpoint, the <code>enable_browser_rendering<\/code>, <code>enable_javascript<\/code>, <code>load_resources<\/code>, and <code>enable_xhr<\/code> parameters are always enabled.\n  - name: browser_screen_width\n    type: integer\n    description: |\n      <em>browser screen width<\/em><br>optional field<br>you can set a custom browser screen width to perform audit for a particular device;<br>if you use this field, you don't need to indicate <code>browser_preset<\/code> as it will be ignored;<p>minimum value, in pixels: <code>240<\/code> <br>maximum value, in pixels: <code>9999<\/code>\n  - name: browser_screen_height\n    type: integer\n    description: |\n      <em>browser screen height<\/em><br>optional field<br>you can set a custom browser screen height to perform audit for a particular device;<br>if you use this field, you don't need to indicate <code>browser_preset<\/code> as it will be ignored;<p>minimum value, in pixels: <code>240<\/code> <br>maximum value, in pixels: <code>9999<\/code>\n  - name: browser_screen_scale_factor\n    type: float\n    description: |\n      <em>browser screen scale factor<\/em><br>optional field<br>you can set a custom browser screen resolution ratio to perform audit for a particular device;<br>if you use this field, you don't need to indicate <code>browser_preset<\/code> as it will be ignored;<p>minimum value: <code>0.5<\/code> <br>maximum value: <code>3<\/code>\n  - name: full_page_screenshot\n    type: boolean\n    description: |\n      <em>take a screenshot of the full page<\/em><br>optional field<br>set to <code>false<\/code> if you want to capture only the part of the page displayed before scrolling<br>default value: <code>true<\/code>\n  - name: disable_cookie_popup\n    type: boolean\n    description: |\n      <em>disable the cookie popup <\/em><br>optional field<br>set to <code>true<\/code> if you want to disable the popup requesting cookie consent from the user;<br>default value: <br><code>false<\/code>\n  - name: switch_pool\n    type: boolean\n    description: |\n      <em>switch proxy pool<\/em><br>optional field<br>if <code>true<\/code>, additional proxy pools will be used to obtain the requested data;<br>the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional <code>rate-limit<\/code> and\/or <code>site_unreachable<\/code> errors\n  - name: ip_pool_for_scan\n    type: string\n    description: |\n      <em>proxy pool<\/em><br>optional field<br>you can choose a location of the proxy pool that will be used to obtain the requested data;<br>the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional <code>site_unreachable<\/code> errors<br>possible values: <code>us<\/code>, <code>de<\/code>","apibase_doc_request_additional_yaml":"","apibase_doc_response_yaml":"parameters:\n  - name: version\n    type: string\n    description: |\n      <em>the current version of the API<\/em>\n  - name: status_code\n    type: integer\n    description: |\n      <i>general status code<\/i><br>you can find the full list of the response codes <a href=\"\/v3\/appendix\/errors\">here<\/a><br><strong>Note:<\/strong> we strongly recommend designing a necessary system for handling related exceptional or error conditions\n  - name: status_message\n    type: string\n    description: |\n      <em>general informational message<\/em><br>you can find the full list of general informational messages <a href=\"\/v3\/appendix\/errors\">here<\/a>\n  - name: time\n    type: string\n    description: |\n      <em>execution time, seconds<\/em>\n  - name: cost\n    type: float\n    description: |\n      <em>total <i>tasks<\/i> cost, USD<\/em>\n  - name: tasks_count\n    type: integer\n    description: |\n      <em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array<\/em>\n  - name: tasks_error\n    type: integer\n    description: |\n      <em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array returned with an error<\/em>\n  - name: tasks\n    type: array\n    description: |\n      <em>array of tasks<\/em>\n    items:\n      children:\n        - name: id\n          type: string\n          description: |\n            <em>task identifier<\/em><br><strong>unique task identifier in our system in the <a href=\"https:\/\/en.wikipedia.org\/wiki\/Universally_unique_identifier\">UUID<\/a> format<\/strong>\n        - name: status_code\n          type: integer\n          description: |\n            <em>status code of the task<\/em><br>generated by DataForSEO; can be within the following range: 10000-60000<br>you can find the full list of the response codes <a href=\"\/v3\/appendix\/errors\">here<\/a>\n        - name: status_message\n          type: string\n          description: |\n            <em>informational message of the task<\/em><br>you can find the full list of general informational messages <a href=\"\/v3\/appendix\/errors\">here<\/a>\n        - name: time\n          type: string\n          description: |\n            <em>execution time, seconds<\/em>\n        - name: cost\n          type: float\n          description: |\n            <em>cost of the task, USD<\/em>\n        - name: result_count\n          type: integer\n          description: |\n            <em>number of elements in the <code>result<\/code> array<\/em>\n        - name: path\n          type: array\n          description: |\n            <em>URL path<\/em>\n        - name: data\n          type: object\n          description: |\n            <em>contains the same parameters that you specified in the POST request<br><\/em>\n        - name: result\n          type: array\n          description: |\n            <em>array of results<\/em>\n          items:\n            children:\n              - name: crawl_progress\n                type: string\n                description: |\n                  <em>status of the crawling session<\/em><br>possible values: <code>in_progress<\/code>, <code>finished<\/code>\n              - name: error_message\n                type: string\n                description: |\n                  <em>error message<\/em><br>if the <code>url<\/code> you indicated returns a 404 status code or is not a valid URL, you will obtain <code>\"error_message\":\"Screenshot is empty\"<\/code><br>if no error is encountered, the value will be <code>null<\/code>\n              - name: items_count\n                type: integer\n                description: |\n                  <em>number of items in the results array<\/em>\n              - name: items\n                type: array\n                description: |\n                  <em>items array<\/em>\n                items:\n                  children:\n                    - name: image\n                      type: string\n                      description: |\n                        <em>screenshot of the requested page<\/em><br>URL of the page screenshot on the DataForSEO storage","footnotes":""},"class_list":["post-13891","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages\/13891","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/users\/17"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/comments?post=13891"}],"version-history":[{"count":22,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages\/13891\/revisions"}],"predecessor-version":[{"id":26158,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages\/13891\/revisions\/26158"}],"wp:attachment":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/media?parent=13891"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}