{"id":9822,"date":"2021-07-14T14:09:19","date_gmt":"2021-07-14T14:09:19","guid":{"rendered":"https:\/\/docs_v3.dataforseo.com\/v3\/?page_id=9822"},"modified":"2026-04-27T11:23:20","modified_gmt":"2026-04-27T11:23:20","slug":"on_page-lighthouse-task_post","status":"publish","type":"page","link":"https:\/\/docs.dataforseo.com\/v3\/on_page-lighthouse-task_post\/","title":{"rendered":"on_page\/lighthouse\/task_post"},"content":{"rendered":"<div class=\"wpb-content-wrapper\"><p>[vc_row][vc_column][vc_column_text]<\/p>\n<h2 id=\"setting-serp-tasks\">Setting Lighthouse Tasks<\/h2>\n<p>\u200cThe OnPage Lighthouse API is based on Google\u2019s open-source Lighthouse project for measuring the quality of web pages and web apps.<\/p>\n<p>Lighthouse measures the quality of web pages by running a series of individual tests for each specific feature or metric to produce a numeric score and generate a report. It can run audits for performance, accessibility, progressive web apps, SEO, and conformity with best practices. You can find the full list of OnPage Lighthouse API audits in the <a href=\"\/v3\/on_page\/lighthouse\/audits\/\">Lighthouse Audits<\/a>\u00a0section. The results of the Lighthouse run will help you to easily strengthen the audited page or web app.<\/p>\n<p><strong>OnPage Lighthouse API is based on an open-source Lighthouse project. <a href=\"https:\/\/github.com\/GoogleChrome\/lighthouse\/blob\/master\/readme.md\" target=\"_blank\" rel=\"noopener noreferrer\">You can find the official documentation here.<\/a><\/strong><br \/>\n[\/vc_column_text]<\/p>\n<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\/lighthouse\/task_post\">\n                https:\/\/api.dataforseo.com\/v3\/on_page\/lighthouse\/task_post                <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\/lighthouse-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). 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. You can send up to 2000 API calls per minute, with each POST call containing no more than 100 tasks. If your POST call contains over 100 tasks, the tasks over this limit will return the <code>40006<\/code> error.<\/p>\n<p>You can retrieve the results of completed tasks using the unique task identifier <code>id<\/code>. Alternatively, we can send them to you as soon as they are ready if you specify\u00a0<code>pingback_url<\/code> when setting a task. Note that if your server doesn&#8217;t respond within 10 seconds, the connection will be aborted by timeout, and the task will be transferred to the <a href=\"\/v3\/on_page\/lighthouse\/tasks_ready\/?php\" target=\"_blank\" rel=\"noopener noreferrer\">&#8216;Tasks Ready&#8217;<\/a> list. The error code and message depend on your server&#8217;s configuration. See <a href=\"https:\/\/dataforseo.com\/help-center\/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center<\/a> to learn more about using pingbacks with DataForSEO APIs.<\/p>\n<p>To get more information about the OnPage Lighthouse API configuration parameters, please refer to the <a href=\"https:\/\/github.com\/GoogleChrome\/lighthouse\/blob\/master\/docs\/understanding-results.md#audits\" target=\"_blank\" rel=\"noopener noreferrer\">official documentation of the Lighthouse project.<\/a><\/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>target URL<\/em><br><strong>required field<\/strong><br>target page should be specified with its absolute URL (including http:\/\/ or https:\/\/)<br>example:<br><code><a href=\"https:\/\/dataforseo.com\/\">https:\/\/dataforseo.com\/<\/a><\/code><\/p><\/td><\/tr><tr data-doc-id=\"for_mobile\"><td><code>for_mobile<\/code><\/td><td>boolean<\/td><td><p><em>applies mobile emulation<\/em><br>optional field<br>if set to <code>true<\/code>, Lighthouse will use mobile device and screen emulation to test the page against mobile environment<br>if set to <code>false<\/code>, the results will be provided for desktop<br>default value: <code>false<\/code><\/p><\/td><\/tr><tr data-doc-id=\"categories\"><td><code>categories<\/code><\/td><td>array<\/td><td><p><em>categories of Lighthouse audits<\/em><br>optional field<br>each category is a collection of audits and audit groups that applies weighting and scoring to the section (<a href=\"https:\/\/github.com\/GoogleChrome\/lighthouse\/blob\/master\/docs\/architecture.md#auditreport-terminology\" target=\"_blank\" rel=\"noopener noreferrer\">see official definition<\/a>)<strong>if you ignore this field, we will return data for all categories unless you specify <code>audits<\/code><\/strong><br>use this field to get data for specific categories you indicate here<p>possible values:<br><code>seo<\/code>, <code>performance<\/code>, <code>best_practices<\/code>, <code>accessibility<\/code><\/p><\/td><\/tr><tr data-doc-id=\"audits\"><td><code>audits<\/code><\/td><td>array<\/td><td><p><em>Lighthouse audits<\/em><br>optional field<br>audits are individual tests Lighthouse runs for each specific feature\/optimization\/metric to produce a numeric score (<a href=\"https:\/\/github.com\/GoogleChrome\/lighthouse\/blob\/master\/docs\/architecture.md#components--terminology\" target=\"_blank\" rel=\"noopener noreferrer\">see official definition<\/a>)<strong>if you ignore this field, we will return data for all audits<\/strong><br>use this field to get data for specific audits you indicate here<p><strong>note<\/strong> that some audits do not belong to a specific category and are stand-alone page quality measurements<p>in general, there can be several use cases:<p>1. if you ignore <code>categories<\/code>, you can use this field to get data for the specified audits only<br>for example, if you ignore <code>\"categories\"<\/code> and specify <code>\"audits\": [\"metrics\/cumulative-layout-shift\",\"metrics\/largest-contentful-paint\",\"metrics\/total-blocking-time\"]<\/code>, you will get data only for these audits<p>2. if you specify a category, you can use this field to additionally receive audits that do not belong to the category(-ies) you specified<br>for example, if you specify <code>\"categories\": [\"seo\"]<\/code> and <code>\"audits\": [\"metrics\/cumulative-layout-shift\",\"metrics\/largest-contentful-paint\",\"metrics\/total-blocking-time\"]<\/code>, you will get only these audits under \"performance\" and all audits under \"seo\"<p>you can get <a href=\"\/v3\/on_page\/lighthouse\/audits\/\">the full list of possible audits here<\/a><\/p><\/td><\/tr><tr data-doc-id=\"version\"><td><code>version<\/code><\/td><td>string<\/td><td><p><em>lighthouse version<\/em><br>optional field<br>you can obtain the results specific to a certain Lighthouse version by specifying its number<br>the list of available versions is available through the <a href=\"\/v3\/on_page\/lighthouse\/versions\/\" target=\"_blank\" rel=\"noopener noreferrer\">Lighthouse Versions endpoint<\/a><\/p><\/td><\/tr><tr data-doc-id=\"language_name\"><td><code>language_name<\/code><\/td><td>string<\/td><td><p><em>lighthouse language name<\/em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name<\/code> by making a separate request to <code><a href=\"https:\/\/api.dataforseo.com\/v3\/on_page\/lighthouse\/languages\">https:\/\/api.dataforseo.com\/v3\/on_page\/lighthouse\/languages<\/a><\/code><br>default value:<br><code class=\"long-string\">English<\/code><\/p><\/td><\/tr><tr data-doc-id=\"language_code\"><td><code>language_code<\/code><\/td><td>string<\/td><td><p><em>lighthouse language code<\/em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code<\/code> by making a separate request to <code><a href=\"https:\/\/api.dataforseo.com\/v3\/on_page\/lighthouse\/languages\">https:\/\/api.dataforseo.com\/v3\/on_page\/lighthouse\/languages<\/a><\/code><br>default value:<br><code class=\"long-string\">en<\/code><\/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>specify the custom user agent used by the browser when running the Lighthouse audit;<br>can be specified with up to 254 characters;<\/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>set the screen width of the browser used for the Lighthouse audit to emulate a specific device;<br>can be specified within the following range: <code>240\u20139999<\/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>set the screen height of the browser used for the Lighthouse audit to emulate a specific device;<br>can be specified within the following range: <code>240\u20139999<\/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>set the device pixel ratio of the browser used for the Lighthouse audit;<br>can be specified within the following range: <code>0.5\u20133<\/code>;<\/p><\/td><\/tr><tr data-doc-id=\"browser_network_throttling_method\"><td><code>browser_network_throttling_method<\/code><\/td><td>string<\/td><td><p><em>browser network throttling method<\/em><br>optional field<br>defines the method used to apply throttling during the Lighthouse audit;<br>possible vaules:<br><code>simulate<\/code> - calculates estimated performance metrics without applying explicit throttling;<br><code>devtools<\/code> -  applies the throttling settings specified in <code>browser_network_throttling<\/code> and <code>browser_cpu_throttling_multiplier<\/code>;<br><code>provided<\/code> - uses the network conditions of the crawling environment;<\/p><\/td><\/tr><tr data-doc-id=\"browser_cpu_throttling_multiplier\"><td><code>browser_cpu_throttling_multiplier<\/code><\/td><td>float<\/td><td><p><em>browser CPU throttling multiplier<\/em><br><strong>required if <code>browser_network_throttling_method<\/code> is set to <code>devtools<\/code>;<\/strong><br>set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit;<br>can be specified within the following range: <code>1\u20134<\/code>;<br><strong>Note:<\/strong> this parameter is applied only when <code>browser_network_throttling_method<\/code> is set to <code>devtools<\/code>;<\/p><\/td><\/tr><tr data-doc-id=\"browser_network_throttling\"><td><code>browser_network_throttling<\/code><\/td><td>string<\/td><td><p><em>browser network throttling<\/em><br><strong>required if <code>browser_network_throttling_method<\/code> is set to <code>devtools<\/code>;<\/strong><br>set the network throttling profile to simulate connection speed conditions during the Lighthouse audit;<br>possible values: <code>no_throttling<\/code>, <code>fast_4g<\/code>, <code>slow_4g<\/code>, <code>regular_3g<\/code>, <code>pc<\/code>;<br><strong>Note:<\/strong> this parameter is applied only when <code>browser_network_throttling_method<\/code> is set to <code>devtools<\/code>;<\/p><\/td><\/tr><tr data-doc-id=\"tag\"><td><code>tag<\/code><\/td><td>string<\/td><td><p><em>user-defined task identifier<\/em><br>optional field<br><em>the character limit is 255<\/em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag<\/code> value in the <code>data<\/code> object of the response<\/p><\/td><\/tr><tr data-doc-id=\"pingback_url\"><td><code>pingback_url<\/code><\/td><td>string<\/td><td><p><em>notification URL of a completed task<\/em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the \u2018$id\u2019 string as a <code>$id<\/code> variable and \u2018$tag\u2019 as urlencoded <code>$tag<\/code> variable. We will set the necessary values before sending the request.<br>example:<br><code><a href=\"http:\/\/your-server.com\/pingscript?id=$id\">http:\/\/your-server.com\/pingscript?id=$id<\/a><\/code><br><code><a href=\"http:\/\/your-server.com\/pingscript?id=$id&amp;tag=$tag\">http:\/\/your-server.com\/pingscript?id=$id&amp;tag=$tag<\/a><\/code><br><strong>Note:<\/strong> special characters in <code>pingback_url<\/code> will be urlencoded;<br>i.a., the <code>#<\/code> character will be encoded into <code>%23<\/code>learn more on our <a href=\"https:\/\/dataforseo.com\/help-center\/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><br \/>\nAs 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<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>result<\/code><\/td><td>array<\/td><td><p><em>array of results<\/em><br>in this case, the value will be <code>null<\/code><\/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\/lighthouse\/task_post&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&quot;,\r\n    &quot;for_mobile&quot;: true,\r\n    &quot;tag&quot;: &quot;some_string_123&quot;,\r\n    &quot;pingback_url&quot;: &quot;https:\/\/your-server.com\/pingscript?id=$id&amp;tag=$tag&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\/\/ example #1 - a simple way to set a task\r\n$post_array[] = array(\r\n   &quot;url&quot; =&gt; &quot;https:\/\/dataforseo.com&quot;,\r\n   &quot;for_mobile&quot; =&gt; true\r\n);\r\n\/\/ example #2 - a way to set a task with additional parameters\r\n$post_array[] = array(\r\n   &quot;url&quot; =&gt; &quot;https:\/\/dataforseo.com&quot;,\r\n   &quot;for_mobile&quot; =&gt; true,\r\n   &quot;tag&quot; =&gt; &quot;some_string_123&quot;,\r\n   &quot;pingback_url&quot; =&gt; &#039;https:\/\/your-server.com\/pingscript?id=$id&amp;tag=$tag&#039;\r\n);\r\n\r\n\/\/ this example has a 2 elements, but in the case of large number of tasks - send up to 100 elements per POST request\r\nif (count($post_array) &gt; 0) {\r\n   try {\r\n      \/\/ POST \/v3\/on_page\/task_post\r\n      \/\/ the full list of possible parameters is available in documentation\r\n      $result = $client-&gt;post(&#039;\/v3\/on_page\/lighthouse\/task_post&#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&quot;,\r\n  &quot;for_mobile&quot;: true,\r\n  &quot;tag&quot;: &quot;some_string_123&quot;,\r\n  &quot;pingback_url&quot;: &quot;https:\/\/your-server.com\/pingscript?id=$id&amp;tag=$tag&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\/lighthouse\/task_post&#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\nrnd = Random()\r\npost_data = dict()\r\n# example #1 - a simple way to set a task\r\npost_data[rnd.randint(1, 30000000)] = dict(\r\n    url=&quot;https:\/\/dataforseo.com&quot;,\r\n    for_mobile=True\r\n)\r\n# example #2 - a way to set a task with additional parameters\r\npost_data[rnd.randint(1, 30000000)] = dict(\r\n    url=&quot;https:\/\/dataforseo.com&quot;,\r\n    for_mobile=True,\r\n    tag=&quot;some_string_123&quot;,\r\n    pingback_url=&quot;https:\/\/your-server.com\/pingscript?id=$id&amp;tag=$tag&quot;\r\n)\r\n# POST \/v3\/on_page\/lighthouse\/task_post\r\n# the full list of possible parameters is available in documentation\r\nresponse = client.post(&quot;\/v3\/on_page\/lighthouse\/task_post&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_task_post()\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            \/\/ example #1 - a simple way to set a task\r\n            postData.Add(new\r\n            {\r\n                url = &quot;https:\/\/dataforseo.com&quot;,\r\n                for_mobile = true\r\n            });\r\n            \/\/ example #2 - a way to set a task with additional parameters\r\n            postData.Add(new\r\n            {\r\n                url = &quot;https:\/\/dataforseo.com&quot;,\r\n                for_mobile = true\r\n                tag = &quot;some_string_123&quot;,\r\n                pingback_url = &quot;https:\/\/your-server.com\/pingscript?id=$id&amp;tag=$tag&quot;\r\n            });\r\n            \/\/ POST \/v3\/on_page\/lighthouse\/task_post\r\n            \/\/ the full list of possible parameters is available in documentation\r\n            var taskPostResponse = await httpClient.PostAsync(&quot;\/v3\/on_page\/lighthouse\/task_post&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.20200805&quot;,\r\n  &quot;status_code&quot;: 20000,\r\n  &quot;status_message&quot;: &quot;Ok.&quot;,\r\n  &quot;time&quot;: &quot;0.0815 sec.&quot;,\r\n  &quot;cost&quot;: 0.00425,\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;08071719-1535-0216-0000-3aabdf68a6ef&quot;,\r\n      &quot;status_code&quot;: 20100,\r\n      &quot;status_message&quot;: &quot;Task Created.&quot;,\r\n      &quot;time&quot;: &quot;0.0044 sec.&quot;,\r\n      &quot;cost&quot;: 0.00425,\r\n      &quot;result_count&quot;: 0,\r\n      &quot;path&quot;: [\r\n        &quot;v3&quot;,\r\n        &quot;on_page&quot;,\r\n        &quot;lighthouse&quot;,\r\n        &quot;task_post&quot;\r\n      ],\r\n      &quot;data&quot;: {\r\n        &quot;api&quot;: &quot;on_page&quot;,\r\n        &quot;function&quot;: &quot;lighthouse&quot;,\r\n        &quot;url&quot;: &quot;https:\/\/dataforseo.com&quot;,\r\n        &quot;for_mobile&quot;: true,\r\n        &quot;tag&quot;: &quot;some_string_123&quot;,\r\n        &quot;pingback_url&quot;: &quot;https:\/\/your-server.com\/pingscript?id=$id&amp;tag=$tag&quot;\r\n      },\r\n      &quot;result&quot;: null\r\n    }\r\n  ]\r\n}<\/code><\/pre><\/div><\/div><\/div><\/div>","protected":false},"excerpt":{"rendered":"<p>[vc_row][vc_column][vc_column_text] Setting Lighthouse Tasks \u200cThe OnPage Lighthouse API is based on Google\u2019s open-source Lighthouse project for measuring the quality of web pages and web apps. Lighthouse measures the quality of web pages by running a series of individual tests for each specific feature or metric to produce a numeric score and generate a report. It [&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>target URL<\/em><br><strong>required field<\/strong><br>target page should be specified with its absolute URL (including http:\/\/ or https:\/\/)<br>example:<br><code>https:\/\/dataforseo.com\/<\/code>\n  - name: for_mobile\n    type: boolean\n    description: |\n      <em>applies mobile emulation<\/em><br>optional field<br>if set to <code>true<\/code>, Lighthouse will use mobile device and screen emulation to test the page against mobile environment<br>if set to <code>false<\/code>, the results will be provided for desktop<br>default value: <code>false<\/code>\n  - name: categories\n    type: array\n    description: |\n      <em>categories of Lighthouse audits<\/em><br>optional field<br>each category is a collection of audits and audit groups that applies weighting and scoring to the section (<a href=\"https:\/\/github.com\/GoogleChrome\/lighthouse\/blob\/master\/docs\/architecture.md#auditreport-terminology\" target=\"_blank\" rel=\"noopener noreferrer\">see official definition<\/a>)<strong>if you ignore this field, we will return data for all categories unless you specify <code>audits<\/code><\/strong><br>use this field to get data for specific categories you indicate here<p>possible values:<br><code>seo<\/code>, <code>performance<\/code>, <code>best_practices<\/code>, <code>accessibility<\/code>\n  - name: audits\n    type: array\n    description: |\n      <em>Lighthouse audits<\/em><br>optional field<br>audits are individual tests Lighthouse runs for each specific feature\/optimization\/metric to produce a numeric score (<a href=\"https:\/\/github.com\/GoogleChrome\/lighthouse\/blob\/master\/docs\/architecture.md#components--terminology\" target=\"_blank\" rel=\"noopener noreferrer\">see official definition<\/a>)<strong>if you ignore this field, we will return data for all audits<\/strong><br>use this field to get data for specific audits you indicate here<p><strong>note<\/strong> that some audits do not belong to a specific category and are stand-alone page quality measurements<p>in general, there can be several use cases:<p>1. if you ignore <code>categories<\/code>, you can use this field to get data for the specified audits only<br>for example, if you ignore <code>\"categories\"<\/code> and specify <code>\"audits\": [\"metrics\/cumulative-layout-shift\",\"metrics\/largest-contentful-paint\",\"metrics\/total-blocking-time\"]<\/code>, you will get data only for these audits<p>2. if you specify a category, you can use this field to additionally receive audits that do not belong to the category(-ies) you specified<br>for example, if you specify <code>\"categories\": [\"seo\"]<\/code> and <code>\"audits\": [\"metrics\/cumulative-layout-shift\",\"metrics\/largest-contentful-paint\",\"metrics\/total-blocking-time\"]<\/code>, you will get only these audits under \"performance\" and all audits under \"seo\"<p>you can get <a href=\"\/v3\/on_page\/lighthouse\/audits\/\">the full list of possible audits here<\/a>\n  - name: version\n    type: string\n    description: |\n      <em>lighthouse version<\/em><br>optional field<br>you can obtain the results specific to a certain Lighthouse version by specifying its number<br>the list of available versions is available through the <a href=\"\/v3\/on_page\/lighthouse\/versions\/\" target=\"_blank\" rel=\"noopener noreferrer\">Lighthouse Versions endpoint<\/a>\n  - name: language_name\n    type: string\n    description: |\n      <em>lighthouse language name<\/em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name<\/code> by making a separate request to <code>https:\/\/api.dataforseo.com\/v3\/on_page\/lighthouse\/languages<\/code><br>default value:<br><code class=\"long-string\">English<\/code>\n  - name: language_code\n    type: string\n    description: |\n      <em>lighthouse language code<\/em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code<\/code> by making a separate request to <code>https:\/\/api.dataforseo.com\/v3\/on_page\/lighthouse\/languages<\/code><br>default value:<br><code class=\"long-string\">en<\/code>\n  - name: custom_user_agent\n    type: string\n    description: |\n      <em>custom user agent<\/em><br>optional field<br>specify the custom user agent used by the browser when running the Lighthouse audit;<br>can be specified with up to 254 characters; \n  - name: browser_screen_width\n    type: integer\n    description: |\n      <em>browser screen width<\/em><br>optional field<br>set the screen width of the browser used for the Lighthouse audit to emulate a specific device;<br>can be specified within the following range: <code>240\u20139999<\/code>; \n  - name: browser_screen_height\n    type: integer\n    description: |\n      <em>browser screen height<\/em><br>optional field<br>set the screen height of the browser used for the Lighthouse audit to emulate a specific device;<br>can be specified within the following range: <code>240\u20139999<\/code>; \n  - name: browser_screen_scale_factor\n    type: float\n    description: |\n      <em>browser screen scale factor<\/em><br>optional field<br>set the device pixel ratio of the browser used for the Lighthouse audit;<br>can be specified within the following range: <code>0.5\u20133<\/code>;\n  - name: browser_network_throttling_method\n    type: string\n    description: |\n      <em>browser network throttling method<\/em><br>optional field<br>defines the method used to apply throttling during the Lighthouse audit;<br>possible vaules:<br><code>simulate<\/code> - calculates estimated performance metrics without applying explicit throttling;<br><code>devtools<\/code> -  applies the throttling settings specified in <code>browser_network_throttling<\/code> and <code>browser_cpu_throttling_multiplier<\/code>;<br><code>provided<\/code> - uses the network conditions of the crawling environment;\n  - name: browser_cpu_throttling_multiplier\n    type: float\n    description: |\n      <em>browser CPU throttling multiplier<\/em><br><strong>required if <code>browser_network_throttling_method<\/code> is set to <code>devtools<\/code>;<\/strong><br>set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit;<br>can be specified within the following range: <code>1\u20134<\/code>;<br><strong>Note:<\/strong> this parameter is applied only when <code>browser_network_throttling_method<\/code> is set to <code>devtools<\/code>;\n  - name: browser_network_throttling\n    type: string\n    description: |\n      <em>browser network throttling<\/em><br><strong>required if <code>browser_network_throttling_method<\/code> is set to <code>devtools<\/code>;<\/strong><br>set the network throttling profile to simulate connection speed conditions during the Lighthouse audit;<br>possible values: <code>no_throttling<\/code>, <code>fast_4g<\/code>, <code>slow_4g<\/code>, <code>regular_3g<\/code>, <code>pc<\/code>;<br><strong>Note:<\/strong> this parameter is applied only when <code>browser_network_throttling_method<\/code> is set to <code>devtools<\/code>;\n  - name: tag\n    type: string\n    description: |\n      <em>user-defined task identifier<\/em><br>optional field<br><em>the character limit is 255<\/em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag<\/code> value in the <code>data<\/code> object of the response\n  - name: pingback_url\n    type: string\n    description: |\n      <em>notification URL of a completed task<\/em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the \u2018$id\u2019 string as a <code>$id<\/code> variable and \u2018$tag\u2019 as urlencoded <code>$tag<\/code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http:\/\/your-server.com\/pingscript?id=$id<\/code><br><code>http:\/\/your-server.com\/pingscript?id=$id&amp;tag=$tag<\/code><br><strong>Note:<\/strong> special characters in <code>pingback_url<\/code> will be urlencoded;<br>i.a., the <code>#<\/code> character will be encoded into <code>%23<\/code>learn more on our <a href=\"https:\/\/dataforseo.com\/help-center\/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center<\/a>","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<\/em>\n        - name: result\n          type: array\n          description: |\n            <em>array of results<\/em><br>in this case, the value will be <code>null<\/code>","footnotes":""},"class_list":["post-9822","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages\/9822","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=9822"}],"version-history":[{"count":28,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages\/9822\/revisions"}],"predecessor-version":[{"id":24424,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages\/9822\/revisions\/24424"}],"wp:attachment":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/media?parent=9822"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}