Skip to main content
POST
https://api.aisa.one/apis/v1
/
dataforseo
/
on_page
/
lighthouse
/
live
/
json
Live OnPage Lighthouse JSON
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/live/json \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "for_mobile": true,
  "categories": [
    "<string>"
  ],
  "audits": [
    "<string>"
  ],
  "version": "<string>",
  "language_name": "<string>",
  "language_code": "<string>",
  "tag": "<string>"
}
'
{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    "<string>"
  ],
  "tasks.id": "<string>",
  "tasks.status_code": 123,
  "tasks.status_message": "<string>",
  "tasks.time": "<string>",
  "tasks.cost": 123,
  "tasks.result_count": 123,
  "tasks.path": [
    "<string>"
  ],
  "tasks.data": {},
  "tasks.result": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://aisa.one/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
url
string
required

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

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

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

​
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

Response

Successful response

​
version
string

the current version of the API

​
status_code
integer

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

​
status_message
string

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

​
time
string

execution time, seconds

​
cost
number

total tasks cost, USD

​
tasks_count
integer

the number of tasks in the tasks array

​
tasks_error
integer

the number of tasks in the tasks array returned with an error

​
tasks
string[]

array of tasks

​
tasks.id
string

task identifier unique task identifier in our system in the UUID format

​
tasks.status_code
integer

status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here

​
tasks.status_message
string

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

​
tasks.time
string

execution time, seconds

​
tasks.cost
number

cost of the task, USD

​
tasks.result_count
integer

number of elements in the result array

​
tasks.path
string[]

URL path

​
tasks.data
object

contains the same parameters that you specified when setting a task

​
tasks.result
string[]

results of Lighthouse audit this array will include data according to the parameters you specified when setting a task; all fields and their descriptions are available in the official documentation by this link.