Felo API PlatformFelo API Platform
Усі endpoint 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

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

    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