Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Live OnPage Lighthouse JSON

Сервер:https://openapi.felo.ai
Клиентские библиотеки

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

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.

Тело
обязательно
application/json
  • Тип: array object[]
    • url
      Тип: string
      обязательно

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

    • audits
      Тип: array 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

    • categories
      Тип: array 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

    • 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

    • 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

    • 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

    • 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

    • 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

Ответы
  • 200
    Тип: object

    Successful response

    • cost
      Тип: number

      total tasks cost, USD

    • 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

    • tasks
      Тип: array string[]

      array of tasks

    • 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.cost
      Тип: number

      cost of the task, USD

    • tasks.data
      Тип: object

      contains the same parameters that you specified when setting a task

    • tasks.id
      Тип: string

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

    • tasks.path
      Тип: array string[]

      URL path

    • tasks.result
      Тип: array 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.

    • tasks.result_count
      Тип: integer

      number of elements in the result array

    • 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

    • time
      Тип: string

      execution time, seconds

    • version
      Тип: string

      the current version of the API

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/on_page/lighthouse/live/json
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/lighthouse/live/json \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "url": "https://example.com",
    "categories": [
      "seo"
    ]
  }
]'
{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ]
}
Live OnPage Lighthouse JSON