Run in Enrichment Spreadsheet
Use this function as a column step in
deepline enrich.deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=dataforseo_on_page_lighthouse_live_json:{"url":"{{url}}"}' --json
Map payload values to spreadsheet columns with
{{column_name}} placeholders.Input Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
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 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 | |
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 Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
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 |
Advanced: Direct CLI
Use direct execution for single payload debugging.
deepline tools execute dataforseo_on_page_lighthouse_live_json --payload '{
"url": "string"
}' --json
CLI flags
| Flag | Description |
|---|---|
--json | Print machine-readable output. |
--wait | Wait for terminal provider status when supported. |
--debug | Enable wait mode with additional status/log output. |
--wait-timeout SECONDS | Max seconds to wait in wait mode. |
--poll-interval SECONDS | Polling interval in seconds during wait mode. |
--timeout SECONDS | Request timeout in seconds. |
--connect-timeout SECONDS | Connection timeout in seconds. |
Cost
- Pricing model:
provider_usage(provider usage). - Estimated Deepline credits:
0.06per pricing unit. - Billing mode:
post_deduct.