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

​

Состояние и ключевые метрики одного обхода по id. Возвращает crawl_progress, crawl_status, crawl_gateway_address, crawl_stop_reason, domain_info и page_metrics. Ответ обёрнут в конверт DataForSEO: данные в tasks[0].result, результат в tasks[0].status_code — отклонённый запрос всё равно возвращает HTTP 200. По нему же узнают, что обход завершён: опрашивайте его, пока crawl_progress не станет finished, прежде чем читать любой другой эндпоинт здесь, иначе вы прочитаете частичные результаты, похожие на настоящие. 💰 Бесплатно на стороне upstream: запрос к завершённому обходу ничего не стоит, платить нужно только за сам обход.

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

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

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

Параметры пути
  • id
    Тип: string
    обязательно

    идентификатор задачи
    обязательное поле
    этот ID можно получить в ответе эндпоинта Task POST
    пример:
    “07131248-1535-0216-1000-17384017ad04”

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

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

    • status_code
      Тип: integer | null

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

    • status_message
      Тип: string | null

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

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

      массив задач

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

            IP-адрес сканера
            показывает IP-адрес, использованный сканером для запуска текущего сеанса сканирования
            полный список IP-адресов, используемых нашим сканером, приведён в разделе обзора

          • crawl_progress
            Тип: string | null

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

          • crawl_status
            Тип: object | null · Response36Afe1097B20_CrawlStatusInfo

            сведения о сеансе сканирования

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

              максимальное количество страниц для обхода указывает заданный при постановке задачи лимит max_crawl_pages

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

              количество просканированных страниц

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

              количество страниц, которые сейчас находятся в очереди на сканирование

          • crawl_stop_reason
            Тип: string | null

            причина остановки сканирования
            информация о причине остановки процесса сканирования;
            возможные значения:
            limit_exceeded — превышен лимит, заданный в max_crawl_pages;
            empty_queue — все URL в очереди просканированы;
            force_stopped — процесс сканирования остановлен с помощью функции On Page API Force Stop;
            unexpected_exception — при сканировании target возникла внутренняя ошибка; обратитесь в поддержку за подробностями

          • domain_info
            Тип: object | null · Response36Afe1097B20_DomainInfo

            информация по всему домену
            информация OnPage о целевом домене и процессе сканирования

            • canonicalization_status_code
              Тип: integer | null

              код состояния, возвращённый канонизированной страницей
              проверка поведения сервера, когда наш краулер пытается обратиться к сайту по IP;
              в большинстве случаев канонизированные страницы должны отвечать кодом состояния 301 или 302

            • checks
              Тип: object | null

              проверки сайта
              прочие проверки страницы, связанные с сайтом

              • propertyName
                Тип: boolean | null
            • cms
              Тип: string | null

              система управления контентом
              система управления контентом, обнаруженная на сайте
              содержимое метатега generator
              данные берутся с первой случайной страницы, возвращающей код ответа 200
              если наш краулер не смог определить CMS, значение будет null

            • crawl_end
              Тип: string | null

              время окончания обхода
              дата и время завершения обхода
              в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”
              пример:
              2019-11-15 12:57:46 +00:00
              Примечание: информативно, только если "crawl_progress" имеет значение "finished"
              если "crawl_progress" имеет значение in_progress, значение будет null

            • crawl_start
              Тип: string | null

              время начала обхода
              дата и время отправки сайта на обход
              в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”
              пример:
              2019-11-15 12:57:46 +00:00

            • directory_browsing_status_code
              Тип: integer | null

              код состояния, возвращённый каталогом
              код состояния, возвращённый страницей каталога на целевом сайте
              в большинстве случаев каталоги должны отвечать кодом состояния 403 или 401

            • extended_crawl_status
              Тип: string | null

              статус и ошибки обхода
              указывает причину, по которой сайт не был обойдён;
              может принимать следующие значения:
              no_errors - ошибок обхода не обнаружено;
              site_unreachable - наш краулер не смог подключиться к сайту и поэтому не смог получить код состояния;
              invalid_page_status_code - код состояния первой обойдённой страницы >= 400;
              forbidden_meta_tag - первая обойдённая страница содержит тег <meta robots="noindex">;
              forbidden_robots - robots.txt запрещает обход страницы;
              forbidden_http_header - HTTP-заголовок страницы содержит "X-Robots-Tag: noindex";
              too_many_redirects - первая обойдённая страница имеет более 10 перенаправлений;
              unknown - причина неизвестна

            • ip
              Тип: string | null

              IP-адрес домена

            • main_domain
              Тип: string | null

              корневое доменное имя

            • name
              Тип: string | null

              имя домена

            • page_not_found_status_code
              Тип: integer | null

              код состояния, возвращённый несуществующей страницей
              в большинстве случаев сервер должен возвращать код ответа 404

            • server
              Тип: string | null

              сервер сайта
              версия сервера, обнаруженная на сайте
              содержимое заголовка server
              информация берётся с первой страницы, код ответа которой — 200

            • ssl_info
              Тип: object | null · Response36Afe1097B20_SslInfo

              информация о SSL-сертификате
              информация о протоколе Secure Sockets Layer, обнаруженном на сайте

              • certificate_expiration_date
                Тип: string | null

                дата истечения срока действия SSL-сертификата
                дата и время истечения срока действия SSL-сертификата
                в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”
                пример:
                2019-11-15 12:57:46 +00:00

              • certificate_hash
                Тип: string | null

                хеш SSL-сертификата
                версия хеш-функции SSL-сертификата

              • certificate_issuer
                Тип: string | null

                центр сертификации SSL
                субъект, выдавший обнаруженный SSL-сертификат

              • certificate_subject
                Тип: string | null

                субъект SSL-сертификата
                субъект, связанный с открытым ключом

              • certificate_version
                Тип: integer | null

                версия SSL-сертификата
                указывает версию X.509, используемую SSL-сертификатом

              • valid_certificate
                Тип: boolean | null

                срок действия SSL-сертификата
                указывает, не является ли обнаруженный на веб-сайте SSL-сертификат просроченным, приостановленным, отозванным или недействительным

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

              всего обойдено страниц
              общее количество обойдённых страниц

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

              всего необойдённых ресурсов
              общее количество ресурсов, которые не удалось обойти;
              ресурс считается необойдённым, если фактический тип контента ресурса не соответствует типу контента, ожидаемому краулером

            • www_redirect_status_code
              Тип: integer | null

              код состояния перенаправления
              код состояния перенаправления с www на без www
              в большинстве случаев перенаправление должно возвращать код состояния 301

          • page_metrics
            Тип: object | null · Response36Afe1097B20_PageMetrics

            информация по страницам
            информация о метриках страниц целевого сайта

            • broken_links
              Тип: integer | null

              количество битых ссылок
              количество битых ссылок на всех просканированных страницах целевого сайта

            • broken_resources
              Тип: integer | null

              количество битых ресурсов
              количество изображений и других ресурсов с битыми ссылками

            • checks
              Тип: object | null

              проверки OnPage по отдельным страницам

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

                Signed 64-bit integers (long type).

            • duplicate_content
              Тип: integer | null

              количество страниц с дублированным контентом

            • duplicate_description
              Тип: integer | null

              количество страниц с дублированными описаниями

            • duplicate_title
              Тип: integer | null

              количество страниц с дублированными заголовками

            • links_external
              Тип: integer | null

              количество внешних ссылок
              количество ссылок, ведущих на другие сайты

            • links_internal
              Тип: integer | null

              количество внутренних ссылок
              количество ссылок, ведущих на другие страницы в пределах целевого сайта

            • links_relation_conflict
              Тип: integer | null

              количество ссылок на целевом сайте, которые могут конфликтовать
              например, если "links_relation_conflict": 2, целевой сайт ссылается на один и тот же источник как минимум одной внутренней ссылкой с атрибутом rel="nofollow" и как минимум одной dofollow-ссылкой

            • non_indexable
              Тип: integer | null

              количество страниц, недоступных для индексации
              количество страниц, которые Google и другие поисковые системы не индексируют из-за настроек robots.txt, HTTP-заголовков или метатегов;
              список URL, недоступных для индексации, можно получить с помощью этого эндпоинта

            • onpage_score
              Тип: number | null

              показывает, насколько сайт оптимизирован по 100-балльной шкале
              это поле показывает, насколько сайт оптимизирован с учётом обнаруженных критических проблем и предупреждений;
              100 — максимально возможная оценка, означающая, что на сайте нет критических проблем и важных предупреждений;
              обратите внимание, что это значение зависит от количества просканированных страниц;
              подробнее о расчёте метрики — в этой статье справочного центра

            • redirect_loop
              Тип: integer | null

              количество цепочек перенаправлений, начинающихся и заканчивающихся на одном URL
              количество цепочек перенаправлений, в которых целевой URL перенаправляет обратно на исходный URL

        • 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 get/v1/beta/dataforseo/on_page/summary/{id}
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/summary/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "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,
          "crawl_status": {
            "max_crawl_pages": null,
            "pages_in_queue": null,
            "pages_crawled": null
          },
          "crawl_gateway_address": null,
          "crawl_stop_reason": null,
          "domain_info": {
            "name": null,
            "cms": null,
            "ip": null,
            "server": null,
            "crawl_start": null,
            "crawl_end": null,
            "extended_crawl_status": null,
            "ssl_info": "[Max Depth Exceeded]",
            "checks": null,
            "total_pages": null,
            "total_uncrawlable_resources": null,
            "page_not_found_status_code": null,
            "canonicalization_status_code": null,
            "directory_browsing_status_code": null,
            "www_redirect_status_code": null,
            "main_domain": null
          },
          "page_metrics": {
            "links_external": null,
            "links_internal": null,
            "duplicate_title": null,
            "duplicate_description": null,
            "duplicate_content": null,
            "broken_links": null,
            "broken_resources": null,
            "links_relation_conflict": null,
            "redirect_loop": null,
            "onpage_score": null,
            "non_indexable": null,
            "checks": null
          }
        }
      ]
    }
  ]
}
OnPage API Summary

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