Felo API PlatformFelo API Platform

Data API / DataForSEO / On Page

Live OnPage Lighthouse JSON

Runs a Google Lighthouse audit on one url and returns the full report: lighthouseVersion, requestedUrl, finalUrl, fetchTime, gatherMode, runWarnings and every audit and category score. for_mobile switches the emulated device, categories and audits narrow the run. Pass categories or audits to cut it down, and prefer post_dataforseo_on_page_waterfall when the question is simply why a page is slow. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

  • urlstringОбязательный

    target URL required field target page should be specified with its absolute URL (including http:// or https://) example: https://dataforseo.com/

  • for_mobilebooleanНеобязательный

    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

  • categoriesstring[]Необязательный

    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

  • auditsstring[]Необязательный

    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

  • versionstringНеобязательный

    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_namestringНеобязательный

    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_codestringНеобязательный

    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

  • tagstringНеобязательный

    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

Пример запроса

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/on_page/lighthouse/live/json" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "<string>",
  "for_mobile": false,
  "categories": [
    "<string>"
  ],
  "audits": [
    "<string>"
  ],
  "version": "<string>",
  "language_name": "<string>",
  "language_code": "<string>",
  "tag": "<string>"
}'

Ответ

Поля ответа

  • versionstringНеобязательный

    the current version of the API

  • status_codeintegerНеобязательный

    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_messagestringНеобязательный

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

  • timestringНеобязательный

    execution time, seconds

  • costnumberНеобязательный

    total tasks cost, USD

  • tasks_countintegerНеобязательный

    the number of tasks in the tasks array

  • tasks_errorintegerНеобязательный

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

  • tasksstring[]Необязательный

    array of tasks

  • idstringНеобязательный

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

  • status_codeintegerНеобязательный

    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

  • status_messagestringНеобязательный

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

  • timestringНеобязательный

    execution time, seconds

  • costnumberНеобязательный

    cost of the task, USD

  • result_countintegerНеобязательный

    number of elements in the result array

  • pathstring[]Необязательный

    URL path

  • dataobjectНеобязательный

    contains the same parameters that you specified when setting a task

  • resultstring[]Необязательный

    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.