Skip to main content
POST
设置 Lighthouse 任务
把 Lighthouse 审计排队而不是等它跑完,返回任务 id。审计耗时超出一次工具调用的耐心时用它;用 get_dataforseo_on_page_lighthouse_task_get_json 取结果,用 get_dataforseo_on_page_lighthouse_ready 看哪些好了。响应包在信封里:数据在 tasks[0].result,成败在 tasks[0].status_code——请求被拒时 HTTP 仍是 200。 ⚠️ 最后拿到的仍是那份 245 KB 的报告,上下文代价只是推迟了、没有消除——要压缩就在这里传 categories / audits,不是等取结果时。

示例

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
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 | null

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
string[] | null

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
string[] | null

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 | null

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 | null

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 | null

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 | null

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<int64> | null

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 | null

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
number | null

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 | null

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
number | null

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 | null

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 | null

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 | null

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&amp;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

示例:

响应

object | null

Successful operation

version
string | null

API 的当前版本

status_code
integer | null

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

status_message
string | null

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

time
string | null

total execution time, seconds

cost
number<double> | null

任务总成本(美元)

tasks_count
integer<int64> | null

tasks 数组中的任务数量

tasks_error
integer<int64> | null

返回错误的 tasks 数组中的任务数量

tasks
(object | null)[] | null

array of tasks