# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"url": "https://dataforseo.com",
"for_mobile": true,
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"url": "https://dataforseo.com",
"for_mobile": true,
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post"
payload = [
{
"url": "https://dataforseo.com",
"for_mobile": True,
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
url: 'https://dataforseo.com',
for_mobile: true,
tag: 'some_string_123',
pingback_url: 'https://your-server.com/pingscript?id=$id&tag=$tag'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'url' => 'https://dataforseo.com',
'for_mobile' => true,
'tag' => 'some_string_123',
'pingback_url' => 'https://your-server.com/pingscript?id=$id&tag=$tag'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post"
payload := strings.NewReader("[\n {\n \"url\": \"https://dataforseo.com\",\n \"for_mobile\": true,\n \"tag\": \"some_string_123\",\n \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"url\": \"https://dataforseo.com\",\n \"for_mobile\": true,\n \"tag\": \"some_string_123\",\n \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"url\": \"https://dataforseo.com\",\n \"for_mobile\": true,\n \"tag\": \"some_string_123\",\n \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n }\n]"
response = http.request(request)
puts response.read_body{
"version": "<string>",
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"cost": 123,
"tasks_count": 123,
"tasks_error": 123,
"tasks": [
{
"id": "<string>",
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"cost": 123,
"result_count": 123,
"path": [
"<string>"
],
"data": {},
"result": [
{}
]
}
]
}Setting Lighthouse Tasks
Queues a Lighthouse audit instead of waiting for one, returning a task id.
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"url": "https://dataforseo.com",
"for_mobile": true,
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"url": "https://dataforseo.com",
"for_mobile": true,
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post"
payload = [
{
"url": "https://dataforseo.com",
"for_mobile": True,
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
url: 'https://dataforseo.com',
for_mobile: true,
tag: 'some_string_123',
pingback_url: 'https://your-server.com/pingscript?id=$id&tag=$tag'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'url' => 'https://dataforseo.com',
'for_mobile' => true,
'tag' => 'some_string_123',
'pingback_url' => 'https://your-server.com/pingscript?id=$id&tag=$tag'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post"
payload := strings.NewReader("[\n {\n \"url\": \"https://dataforseo.com\",\n \"for_mobile\": true,\n \"tag\": \"some_string_123\",\n \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"url\": \"https://dataforseo.com\",\n \"for_mobile\": true,\n \"tag\": \"some_string_123\",\n \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"url\": \"https://dataforseo.com\",\n \"for_mobile\": true,\n \"tag\": \"some_string_123\",\n \"pingback_url\": \"https://your-server.com/pingscript?id=$id&tag=$tag\"\n }\n]"
response = http.request(request)
puts response.read_body{
"version": "<string>",
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"cost": 123,
"tasks_count": 123,
"tasks_error": 123,
"tasks": [
{
"id": "<string>",
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"cost": 123,
"result_count": 123,
"path": [
"<string>"
],
"data": {},
"result": [
{}
]
}
]
}id. Use it when the audit would outlast a tool call’s patience; retrieve with get_dataforseo_on_page_lighthouse_task_get_json, and see what is ready with get_dataforseo_on_page_lighthouse_ready. Wrapped in DataForSEO’s envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. ⚠️ Same 245 KB report at the end, so the context cost is deferred, not avoided - narrow it with categories or audits here, not later.
Example
curl -X POST "https://api.aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_post" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '[{"url": "...", "for_mobile": "...", "categories": "..."}]'
Cost and request rules
Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Default request reference estimate (USD): 0.0051
- Cost contract: response_usd
- Published reference multiplier: 1.0
- Settlement evidence source: response_body
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
target URL
required field
target page should be specified with its absolute URL (including http:// or https://)
example:https://dataforseo.com/
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 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
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
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
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
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
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
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
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
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
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
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
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;
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
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=$idhttp://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
[ { "url": "https://dataforseo.com", "for_mobile": true, "tag": "some_string_123", "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag" } ]
Response
Successful operation
the current version of the API
general status code you can find the full list of the response codes here
general informational message you can find the full list of general informational messages here
total execution time, seconds
total tasks cost, USD
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
array of tasks
Show child attributes
Show child attributes