url | string | target URL required field target page should be specified with its absolute URL (including http:// or https://) example:
https://dataforseo.com/ |
for_mobile | boolean | applies mobile emulation optional field if set to true, Lighthouse will use mobile device and screen emulation to test the page against mobile environment if set to false, the results will be provided for desktop default value: false |
categories | array | categories of Lighthouse audits optional field each category is a collection of audits and audit groups that applies weighting and scoring to the section (see official definition)if you ignore this field, we will return data for all categories unless you specify audits use this field to get data for specific categories you indicate here possible values:
seo, performance, best_practices, accessibility |
audits | array | Lighthouse audits optional field audits are individual tests Lighthouse runs for each specific feature/optimization/metric to produce a numeric score (see official definition)if you ignore this field, we will return data for all audits use this field to get data for specific audits you indicate here note that some audits do not belong to a specific category and are stand-alone page quality measurements in general, there can be several use cases: 1. if you ignore categories, you can use this field to get data for the specified audits only for example, if you ignore "categories" and specify "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], you will get data only for these audits 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 for example, if you specify "categories": ["seo"] and "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], you will get only these audits under "performance" and all audits under "seo" you can get the full list of possible audits here |
version | string | lighthouse version optional field you can obtain the results specific to a certain Lighthouse version by specifying its number the list of available versions is available through the Lighthouse Versions endpoint |
language_name | string | lighthouse language name optional field you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/on_page/lighthouse/languages default value:
English |
language_code | string | lighthouse language code optional field you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/on_page/lighthouse/languages default value:
en |
custom_user_agent | string | custom user agent optional field specify the custom user agent used by the browser when running the Lighthouse audit; can be specified with up to 254 characters; |
browser_screen_width | integer | browser screen width optional field set the screen width of the browser used for the Lighthouse audit to emulate a specific device; can be specified within the following range: 240–9999; |
browser_screen_height | integer | browser screen height optional field set the screen height of the browser used for the Lighthouse audit to emulate a specific device; can be specified within the following range: 240–9999; |
browser_screen_scale_factor | float | browser screen scale factor optional field set the device pixel ratio of the browser used for the Lighthouse audit; can be specified within the following range: 0.5–3; |
browser_network_throttling_method | string | browser network throttling method optional field defines the method used to apply throttling during the Lighthouse audit; possible vaules:
simulate - calculates estimated performance metrics without applying explicit throttling;
devtools - applies the throttling settings specified in browser_network_throttling and browser_cpu_throttling_multiplier;
provided - uses the network conditions of the crawling environment; |
browser_cpu_throttling_multiplier | float | browser CPU throttling multiplier required if browser_network_throttling_method is set to devtools; set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit; can be specified within the following range: 1–4; Note: this parameter is applied only when browser_network_throttling_method is set to devtools; |
browser_network_throttling | string | browser network throttling required if browser_network_throttling_method is set to devtools; set the network throttling profile to simulate connection speed conditions during the Lighthouse audit; possible values: no_throttling, fast_4g, slow_4g, regular_3g, pc; Note: this parameter is applied only when browser_network_throttling_method is set to devtools; |
tag | string | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |
pingback_url | string | notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example:
http://your-server.com/pingscript?id=$id
http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center |