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

Скриншот страницы OnPage API

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

DataForSEO

​

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

Скриншот страницы OnPage API

​

Рендерит любой url и возвращает скриншот; full_page_screenshot включает всю высоту прокрутки, а browser_screen_width и browser_screen_height задают область просмотра. Работает автономно — обход не нужен. Ответ обёрнут в конверт DataForSEO: данные в tasks[0].result, результат в tasks[0].status_code — отклонённый запрос всё равно возвращает HTTP 200. ⚠️ Изображение — большой результат инструмента ещё до того, как агент сможет с ним что-то сделать; запрашивайте скриншот, только когда важен именно визуал, а если нужен текст, используйте post_dataforseo_on_page_content_parsing_live.

Справочные цены

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

Справочные метаданные, а не коммерческое предложение для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

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

      языковой заголовок для доступа к веб-сайту
      необязательное поле
      поддерживаются все форматы локалей (xx, xx-XX, xxx-XX и т. д.)
      примечание: если не указать этот параметр, некоторые веб-сайты могут отказать в доступе; в этом случае в массиве ответа вы получите "error_message":"Screenshot is empty"

    • browser_preset
      Тип: string | null

      пресет параметров экрана браузера
      необязательное поле
      если вы используете это поле, указывать browser_screen_width, browser_screen_height, browser_screen_scale_factor не нужно

      возможные значения:
      desktop, mobile, tablet

      пресет desktop применяет следующие значения:

      browser_screen_width: 1920
      browser_screen_height: 1080
      browser_screen_scale_factor: 1

      пресет mobile применяет следующие значения:

      browser_screen_width: 390
      browser_screen_height: 844
      browser_screen_scale_factor: 3

      пресет tablet применяет следующие значения:

      browser_screen_width: 1024
      browser_screen_height: 1366
      browser_screen_scale_factor: 2

      Примечание: в этом эндпоинте параметры enable_browser_rendering, enable_javascript, load_resources и enable_xhr всегда включены.

    • browser_screen_height
      Тип: integer | null

      высота экрана браузера
      необязательное поле
      можно задать собственную высоту экрана браузера для аудита конкретного устройства;
      если вы используете это поле, указывать browser_preset не нужно, так как он будет проигнорирован;

      минимальное значение в пикселях: 240
      максимальное значение в пикселях: 9999

    • browser_screen_scale_factor
      Тип: number | null

      масштаб экрана браузера
      необязательное поле
      можно задать собственное соотношение разрешения экрана браузера для аудита конкретного устройства;
      если вы используете это поле, указывать browser_preset не нужно, так как он будет проигнорирован;

      минимальное значение: 0.5
      максимальное значение: 3

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

      ширина экрана браузера
      необязательное поле
      можно задать собственную ширину экрана браузера для аудита конкретного устройства;
      если вы используете это поле, указывать browser_preset не нужно, так как он будет проигнорирован;

      минимальное значение в пикселях: 240
      максимальное значение в пикселях: 9999

    • custom_user_agent
      Тип: string | null

      пользовательский user agent
      необязательное поле
      пользовательский user agent для обхода веб-сайта
      пример: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36

      значение по умолчанию: Mozilla/5.0 (compatible; RSiteAuditor)

    • disable_cookie_popup
      Тип: boolean | null

      отключить всплывающее окно cookie
      необязательное поле
      задайте true, если хотите отключить всплывающее окно с запросом согласия на использование cookie;
      значение по умолчанию:
      false

    • full_page_screenshot
      Тип: boolean | null

      сделать снимок всей страницы
      необязательное поле
      задайте false, если хотите захватить только часть страницы, отображаемую до прокрутки
      значение по умолчанию: true

    • ip_pool_for_scan
      Тип: string | null

      пул прокси
      необязательное поле
      можно выбрать расположение пула прокси, который будет использоваться для получения запрошенных данных;
      параметр можно использовать, если содержимое страницы недоступно в одном из расположений, что приводит к периодическим ошибкам site_unreachable
      возможные значения: us, de

    • switch_pool
      Тип: boolean | null

      переключение пула прокси
      необязательное поле
      если true, для получения запрошенных данных будут использоваться дополнительные пулы прокси;
      параметр можно использовать, если одновременно задано множество задач, что приводит к периодическим ошибкам rate-limit и/или site_unreachable

    • url
      Тип: string

      URL страницы
      обязательное поле
      абсолютный URL страницы для снимка
      примечание: если указанный здесь URL возвращает код состояния 404 или указанное значение не является допустимым URL, в массиве ответа вы получите "error_message":"Screenshot is empty"

Ответы
  • 200
    Тип: object | null · Response36Afe1097B20_OnPagePageScreenshotResponseInfo
    • cost
      Тип: number | null Формат: double

      общая стоимость задач, USD

    • status_code
      Тип: integer | null

      общий код состояния. Полный список кодов ответа можно найти здесь.

    • status_message
      Тип: string | null

      общее информационное сообщение. Полный список общих информационных сообщений можно найти здесь.

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

      массив задач

      • Тип: object | null · Response36Afe1097B20_OnPagePageScreenshotTaskInfo
        • 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

          массив результатов

          • crawl_progress
            Тип: string | null

            статус сеанса сканирования
            возможные значения: in_progress, finished

          • error_message
            Тип: string | null

            сообщение об ошибке
            если указанный url возвращает код состояния 404 или не является допустимым URL, вы получите "error_message":"Screenshot is empty"
            если ошибки нет, значение будет null

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

            массив элементов

            • image
              Тип: string | null

              скриншот запрошенной страницы
              URL скриншота страницы в хранилище DataForSEO
              примечание: скриншот страницы, сохранённый в хранилище DataForSEO, доступен только в течение одного дня после выполнения запроса

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

            количество элементов в массиве результатов

        • 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/page_screenshot
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/page_screenshot \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "url": "https://dataforseo.com/apis"
  }
]'
{
  "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": [
        {
          "crawl_progress": null,
          "error_message": null,
          "items_count": null,
          "items": [
            {
              "image": null
            }
          ]
        }
      ]
    }
  ]
}
OnPage API Page Screenshot

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