DataForSEO: On Page Lighthouse Live Json

Run a Lighthouse audit on a web page for performance, accessibility, SEO and best-practice scores.

Tool ID: dataforseo_on_page_lighthouse_live_json

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_on_page_lighthouse_live_json',
  {
    "url": "https://example.com"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute dataforseo_on_page_lighthouse_live_json --input '{
  "url": "https://example.com"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}

Use deepline describe dataforseo_on_page_lighthouse_live_json --json for the latest machine-readable contract.

Input reference

The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps.

Name	Type	Required	Default	Details
`payload.url`	`string`	Yes	—	target URL required field target page should be specified with its absolute URL (including http:// or https://) example: https://dataforseo.com/
`payload.for_mobile`	`unknown`	No	—	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
`payload.categories`	`array`	No	—	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
`payload.audits`	`array`	No	—	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 See the live schema for the complete constraint.
`payload.version`	`string`	No	—	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
`payload.language_name`	`string`	No	—	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
`payload.language_code`	`string`	No	—	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
`payload.tag`	`string`	No	—	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

Output reference

Top-level response envelope for dataforseo_on_page_lighthouse_live_json.

Name	Type	Required	Default	Details
`result.version`	`string`	Yes	—	the current version of the API
`result.status_code`	`integer`	Yes	—	general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
`result.status_message`	`string`	Yes	—	general informational message you can find the full list of general informational messages here
`result.time`	`string`	Yes	—	execution time, seconds
`result.tasks_count`	`integer`	Yes	—	the number of tasks in the tasks array
`result.tasks_error`	`integer`	Yes	—	the number of tasks in the tasks array returned with an error
`result.tasks`	`array`	Yes	—	array of tasks

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0.06 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation