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. Читает завершённый обход, поэтому нужен id из post_dataforseo_on_page_submit, и возвращает crawl_progress и crawl_status со значениями max_crawl_pages, pages_in_queue и pages_crawled — проверяйте их, прежде чем доверять небольшому результату: у ещё идущего обхода просто меньше данных. ⚠️ Страница должна была входить в обход: если запросить URL, которого там не было, вернётся status_code 40406 и Requested page was not submitted for crawling внутри HTTP 200. Увеличьте max_crawl_pages или задайте start_url при отправке, если нужной страницы нет. 💰 Бесплатно на стороне upstream: запрос к завершённому обходу ничего не стоит, платить нужно только за сам обход.

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

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

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

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

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

    • tag
      Тип: string | null

      пользовательский идентификатор задачи
      необязательное поле
      ограничение — 255 символов
      этот параметр позволяет идентифицировать задачу и сопоставить её с результатом
      указанное значение tag вы найдёте в объекте data ответа

    • url
      Тип: string

      URL ресурса
      обязательное поле
      этот URL можно получить в ответе эндпоинта Pages
      пример:
      https://dataforseo.com/apis

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

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

    • status_code
      Тип: integer | null

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

    • status_message
      Тип: string | null

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

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

      массив задач

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

          • 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

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

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

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

            • inspection_info
              Тип: object | null · Response36Afe1097B20_MicrodataInspectionInfo

              информация о проверке микроразметки

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

                поля микроразметки
                массив объектов с полями данных, относящимися к определённому типу микроразметки

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

                  поля микроразметки
                  массив объектов с полями данных, относящимися к определённому типу микроразметки

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

                    поля микроразметки
                    массив объектов с полями данных, относящимися к определённому типу микроразметки

                  • name
                    Тип: string | null

                    имя поля
                    название поля данных

                  • test_results
                    Тип: object | null · Response36Afe1097B20_MessageInfo

                    результаты проверки микроразметки
                    результаты проверки микроразметки подтипа, содержащие обнаруженные ошибки и связанные сообщения

                    • level
                      Тип: string | null

                      уровень ошибки может принимать следующие значения: fatal, error, warning, info

                    • message
                      Тип: string | null

                      сообщение, связанное с ошибкой сообщение с подробностями обнаруженной ошибки

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

                    список типов микроразметки

                  • value
                    Тип: string | null

                    значение микроразметки значение микроразметки, указанное на целевой веб-странице

                • name
                  Тип: string | null

                  имя поля
                  название поля данных

                • test_results
                  Тип: object | null · Response36Afe1097B20_MessageInfo

                  результаты проверки микроразметки
                  результаты проверки микроразметки подтипа, содержащие обнаруженные ошибки и связанные сообщения

                  • level
                    Тип: string | null

                    уровень ошибки может принимать следующие значения: fatal, error, warning, info

                  • message
                    Тип: string | null

                    сообщение, связанное с ошибкой сообщение с подробностями обнаруженной ошибки

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

                  список типов микроразметки

                • value
                  Тип: string | null

                  значение микроразметки значение микроразметки, указанное на целевой веб-странице

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

                родительские типы микроразметки
                полный список доступных типов см. на schema.org

            • type
              Тип: string | null

              тип элемента

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

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

          • test_summary
            Тип: object | null · Response36Afe1097B20_TestSummary

            результаты проверки микроразметки

            • error
              Тип: integer | null

              количество серьёзных ошибок микроразметки

            • fatal
              Тип: integer | null

              количество фатальных ошибок микроразметки

            • info
              Тип: integer | null

              количество информационных флагов микроразметки

            • warning
              Тип: integer | 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/microdata
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/microdata \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "id": "02241700-1535-0216-0000-034137259bc1",
    "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,
          "crawl_status": {
            "max_crawl_pages": null,
            "pages_in_queue": null,
            "pages_crawled": null
          },
          "test_summary": {
            "fatal": null,
            "error": null,
            "warning": null,
            "info": null
          },
          "items_count": null,
          "items": [
            {
              "type": null,
              "inspection_info": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}
OnPage API Microdata

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