Felo API PlatformFelo API Platform
Усі endpoint DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

Постановка завдань Lighthouse

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клієнтські бібліотеки
Shell Curl

DataForSEO

​

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

DataForSEO Операції

Постановка завдань Lighthouse

​

Ставить аудит Lighthouse у чергу замість очікування й повертає id завдання. Використовуйте, коли аудит може тривати довше, ніж готовий чекати виклик інструмента; отримуйте через get_dataforseo_on_page_lighthouse_task_get_json, а готові завдання дивіться через get_dataforseo_on_page_lighthouse_ready. Відповідь обгорнуто в конверт DataForSEO: дані в tasks[0].result, результат у tasks[0].status_code — відхилений запит усе одно повертає HTTP 200. ⚠️ Наприкінці буде той самий звіт на 245 КБ, тож вартість контексту відкладається, а не зникає — звужуйте його через categories або audits тут, а не потім.

Довідкові ціни

  • Тарифікація: вартість відповіді за даними постачальника.
  • Довідкова оцінка запиту: USD 0.0051.
  • Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

Тіло
application/json
  • Тип: array (object | null)[]
    • audits
      Тип: array string[] | null

      аудити Lighthouse
      необов'язкове поле
      аудити — це окремі тести, які Lighthouse виконує для кожного конкретного компонента/оптимізації/метрики, щоб отримати числову оцінку (див. офіційне визначення)якщо проігнорувати це поле, ми повернемо дані щодо всіх аудитів
      використовуйте це поле, щоб отримати дані щодо вказаних тут конкретних аудитів

      примітка: деякі аудити не належать до конкретної категорії та є окремими вимірюваннями якості сторінки

      загалом можливі кілька варіантів використання:

      1. якщо проігнорувати categories, це поле дає змогу отримати дані лише щодо вказаних аудитів
      наприклад, якщо проігнорувати "categories" і вказати "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], ви отримаєте дані лише щодо цих аудитів

      2. якщо вказати категорію, це поле дає змогу додатково отримати аудити, що не належать до вказаних категорій
      наприклад, якщо вказати "categories": ["seo"] і "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], ви отримаєте лише ці аудити в розділі "performance" і всі аудити в розділі "seo"

      повний список можливих аудитів можна отримати тут

    • browser_cpu_throttling_multiplier
      Тип: number | null

      множник тротлінгу CPU браузера
      обов'язково, якщо для browser_network_throttling_method задано значення devtools;
      задайте множник тротлінгу CPU для імітації умов продуктивності пристрою під час аудиту Lighthouse;
      можна вказати в такому діапазоні: 1–4;
      Примітка: цей параметр застосовується, лише коли для browser_network_throttling_method задано значення devtools;

    • browser_network_throttling
      Тип: string | null

      мережевий тротлінг браузера
      обов'язково, якщо для browser_network_throttling_method задано значення devtools;
      задайте профіль мережевого тротлінгу для імітації умов швидкості з'єднання під час аудиту Lighthouse;
      можливі значення: no_throttling, fast_4g, slow_4g, regular_3g, pc;
      Примітка: цей параметр застосовується, лише коли для browser_network_throttling_method задано значення devtools;

    • browser_network_throttling_method
      Тип: string | null

      метод мережевого тротлінгу браузера
      необов'язкове поле
      визначає метод застосування тротлінгу під час аудиту Lighthouse;
      можливі значення:
      simulate - розраховує оцінні метрики продуктивності без явного застосування тротлінгу;
      devtools - застосовує налаштування тротлінгу, указані в browser_network_throttling і browser_cpu_throttling_multiplier;
      provided - використовує мережеві умови середовища обходу;

    • browser_screen_height
      Тип: integer | null

      висота екрана браузера
      необов'язкове поле
      задайте висоту екрана браузера, що використовується для аудиту Lighthouse, щоб емулювати конкретний пристрій;
      можна вказати в такому діапазоні: 240–9999;

    • browser_screen_scale_factor
      Тип: number | null

      масштаб екрана браузера
      необов'язкове поле
      задайте співвідношення пікселів пристрою браузера, що використовується для аудиту Lighthouse;
      можна вказати в такому діапазоні: 0.5–3;

    • browser_screen_width
      Тип: integer | null Формат: int64

      ширина екрана браузера
      необов'язкове поле
      задайте ширину екрана браузера, що використовується для аудиту Lighthouse, щоб емулювати конкретний пристрій;
      можна вказати в такому діапазоні: 240–9999;

    • categories
      Тип: array string[] | null

      категорії аудитів Lighthouse
      необов'язкове поле
      кожна категорія — це набір аудитів і груп аудитів, який застосовує вагові коефіцієнти й оцінку до розділу (див. офіційне визначення)якщо проігнорувати це поле, ми повернемо дані щодо всіх категорій, якщо не вказано audits
      використовуйте це поле, щоб отримати дані щодо вказаних тут конкретних категорій

      можливі значення:
      seo, performance, best_practices, accessibility

    • custom_user_agent
      Тип: string | null

      власний user agent
      необов'язкове поле
      укажіть власний user agent, який використовує браузер під час аудиту Lighthouse;
      можна вказати до 254 символів;

    • for_mobile
      Тип: boolean | null

      застосовувати мобільну емуляцію
      необов'язкове поле
      якщо встановлено true, Lighthouse використовуватиме емуляцію мобільного пристрою та екрана для перевірки сторінки в мобільному середовищі
      якщо встановлено false, результати буде надано для настільного комп'ютера
      значення за замовчуванням: false

    • language_code
      Тип: string | null

      код мови Lighthouse
      необов'язкове поле
      список доступних мов пошукової системи з їхніми language_code можна отримати, надіславши окремий запит до https://api.dataforseo.com/v3/on_page/lighthouse/languages
      значення за замовчуванням:
      en

    • language_name
      Тип: string | null

      назва мови Lighthouse
      необов'язкове поле
      список доступних мов пошукової системи з їхніми language_name можна отримати, надіславши окремий запит до https://api.dataforseo.com/v3/on_page/lighthouse/languages
      значення за замовчуванням:
      English

    • pingback_url
      Тип: string | null

      URL сповіщення про завершене завдання
      необов'язкове поле
      після завершення завдання ми надішлемо GET-запит на вказаний вами URL
      рядок ‘$id’ можна використовувати як змінну $id, а ‘$tag’ — як urlencoded-змінну $tag. Перед надсиланням запиту ми підставимо потрібні значення.
      приклад:
      http://your-server.com/pingscript?id=$id
      http://your-server.com/pingscript?id=$id&tag=$tag
      Примітка: спеціальні символи в pingback_url буде urlencoded;
      зокрема, символ # буде закодовано як %23. Докладніше в нашому Help Center

    • tag
      Тип: string | null

      визначений користувачем ідентифікатор завдання
      необов'язкове поле
      обмеження — 255 символів
      цей параметр дає змогу ідентифікувати завдання й зіставити його з результатом
      вказане значення tag ви знайдете в об'єкті data відповіді

    • url
      Тип: string

      цільовий URL
      обов'язкове поле
      цільову сторінку слід указувати з абсолютним URL (включно з http:// або https://)
      приклад:
      https://dataforseo.com/

    • version
      Тип: string | null

      версія Lighthouse
      необов'язкове поле
      можна отримати результати, що стосуються певної версії Lighthouse, указавши її номер
      список доступних версій доступний через ендпоінт Lighthouse Versions

Відповіді
  • 200
    Тип: object | null · Response36Afe1097B20_OnPageLighthouseTaskPostResponseInfo
    • cost
      Тип: number | null Формат: double

      загальна вартість завдань, USD

    • status_code
      Тип: integer | null

      загальний код стану. Повний список кодів відповіді можна знайти тут.

    • status_message
      Тип: string | null

      загальне інформаційне повідомлення. Повний список загальних інформаційних повідомлень можна знайти тут.

    • tasks
      Тип: array (object | null)[] | null

      масив завдань

      • Тип: object | null · Response36Afe1097B20_OnPageLighthouseTaskPostTaskInfo
        • cost
          Тип: number | null Формат: double

          загальна вартість завдань, USD

        • data
          Тип: object | null

          містить ті самі параметри, які ви вказали в POST-запиті

          • propertyName
            Тип: object | null
        • id
          Тип: string | null

          ідентифікатор завдання унікальний ідентифікатор завдання в нашій системі у форматі UUID

        • path
          Тип: array (string | null)[] | null

          шлях URL

        • result
          Тип: array (object | null)[] | null
          • propertyName
            Тип: object | null
        • result_count
          Тип: integer | null Формат: int64

          кількість елементів у масиві result

        • status_code
          Тип: integer | null

          код стану завдання формується DataForSEO, може перебувати в діапазоні 10000-60000 Повний список кодів відповіді можна знайти тут.

        • status_message
          Тип: string | null

          інформаційне повідомлення завдання Повний список загальних інформаційних повідомлень можна знайти тут.

        • time
          Тип: string | null

          час виконання, секунди

    • tasks_count
      Тип: integer | null Формат: int64

      кількість завдань у масиві tasks

    • tasks_error
      Тип: integer | null Формат: int64

      кількість завдань у масиві tasks, повернутих з помилкою

    • time
      Тип: string | null

      загальний час виконання, секунди

    • version
      Тип: string | null

      поточна версія API

    application/json
  • 400

    Не вдалося обробити запит. Перевірте параметри запиту.

  • 401

    Потрібен дійсний API-ключ Felo.

  • 402

    Запит неможливо виконати: умови білінгу не виконано.

  • 403

    Обліковий запис не має дозволу на цю операцію.

  • 429

    Досягнуто ліміту запитів або витрат.

  • 502

    Служба не змогла виконати запит.

  • 503

    API або служба білінгу тимчасово недоступні.

  • 504

    Час очікування обробки запиту вичерпано.

  • default

    Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

    application/json
Request Example for post/v1/beta/dataforseo/on_page/lighthouse/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/lighthouse/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "url": "https://dataforseo.com",
    "for_mobile": true,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]'

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        null
      ]
    }
  ]
}

Успішна операція

Setting Lighthouse Tasks