Felo API PlatformFelo API Platform
Все эндпоинты DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

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

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

DataForSEO

​

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

Постановка задач 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

    Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

    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

Нужна помощь?