# Сводка OnPage API **API:** Data API **Endpoint:** `GET /v1/beta/dataforseo/on_page/summary/{id}` **Tags:** DataForSEO Состояние и ключевые метрики одного обхода по `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. ## Base URL - `https://openapi.felo.ai` ## Authentication - `FeloBearerAuth` (http bearer, bearer format Felo API Key) - `FeloApiKey` (apiKey in header `X-API-Key`) ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | `id` | path | yes | string | идентификатор задачи
обязательное поле
этот ID можно получить в ответе эндпоинта Task POST
пример:
“07131248-1535-0216-1000-17384017ad04” | ## Responses ### 200 — Успешная операция Headers: - `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo. **application/json** Schema: object | null ```json { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_OnPageSummaryResponseInfo" } ] } ``` ### 400 — Запрос не удалось обработать. Проверьте параметры запроса. ### 401 — Требуется действительный API-ключ Felo. ### 402 — Запрос не может быть выполнен: не выполнено требование биллинга. ### 403 — Аккаунту не разрешено выполнять эту операцию. ### 429 — Достигнут лимит запросов или расходов. ### 502 — Сервис не смог выполнить запрос. ### 503 — API или сервис биллинга временно недоступны. ### 504 — Истекло время ожидания обработки запроса. ### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера **application/json** Schema: ```json {} ``` ## Schema definitions ### Response36Afe1097B20_BaseResponseInfo `#/components/schemas/Response36Afe1097B20_BaseResponseInfo` ```json { "properties": { "version": { "type": [ "string", "null" ], "description": "текущая версия API" }, "status_code": { "type": [ "integer", "null" ], "description": "общий код состояния.\nПолный список кодов ответа можно найти здесь." }, "status_message": { "type": [ "string", "null" ], "description": "общее информационное сообщение.\nПолный список общих информационных сообщений можно найти здесь." }, "time": { "type": [ "string", "null" ], "description": "общее время выполнения, секунды" }, "cost": { "type": [ "number", "null" ], "description": "общая стоимость задач, USD", "format": "double" }, "tasks_count": { "type": [ "integer", "null" ], "description": "число задач в массиве tasks", "format": "int64" }, "tasks_error": { "type": [ "integer", "null" ], "description": "число задач в массиве tasks, возвращённых с ошибкой", "format": "int64" } } } ``` ### Response36Afe1097B20_BaseResponseTaskInfo `#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo` ```json { "properties": { "id": { "type": [ "string", "null" ], "description": "идентификатор задачи\nуникальный идентификатор задачи в нашей системе в формате UUID" }, "status_code": { "type": [ "integer", "null" ], "description": "код состояния задачи\nформируется DataForSEO, может находиться в диапазоне 10000-60000\nПолный список кодов ответа можно найти здесь." }, "status_message": { "type": [ "string", "null" ], "description": "информационное сообщение задачи\nПолный список общих информационных сообщений можно найти здесь." }, "time": { "type": [ "string", "null" ], "description": "время выполнения, секунды" }, "cost": { "type": [ "number", "null" ], "description": "общая стоимость задач, USD", "format": "double" }, "result_count": { "type": [ "integer", "null" ], "description": "число элементов в массиве result", "format": "int64" }, "path": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] }, "description": "путь URL" }, "data": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "object", "null" ] }, "description": "содержит те же параметры, что вы указали в POST-запросе" } } } ``` ### Response36Afe1097B20_CrawlStatusInfo `#/components/schemas/Response36Afe1097B20_CrawlStatusInfo` ```json { "type": "object", "properties": { "max_crawl_pages": { "type": [ "integer", "null" ], "description": "максимальное количество страниц для обхода\nуказывает заданный при постановке задачи лимит max_crawl_pages", "format": "int64" }, "pages_in_queue": { "type": [ "integer", "null" ], "description": "количество страниц, которые сейчас находятся в очереди на сканирование", "format": "int64" }, "pages_crawled": { "type": [ "integer", "null" ], "description": "количество просканированных страниц", "format": "int64" } } } ``` ### Response36Afe1097B20_DomainInfo `#/components/schemas/Response36Afe1097B20_DomainInfo` ```json { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "имя домена" }, "cms": { "type": [ "string", "null" ], "description": "система управления контентом
система управления контентом, обнаруженная на сайте
содержимое метатега generator
данные берутся с первой случайной страницы, возвращающей код ответа 200
если наш краулер не смог определить CMS, значение будет null" }, "ip": { "type": [ "string", "null" ], "description": "IP-адрес домена" }, "server": { "type": [ "string", "null" ], "description": "сервер сайта
версия сервера, обнаруженная на сайте
содержимое заголовка server
информация берётся с первой страницы, код ответа которой — 200" }, "crawl_start": { "type": [ "string", "null" ], "description": "время начала обхода
дата и время отправки сайта на обход
в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”
пример:
2019-11-15 12:57:46 +00:00" }, "crawl_end": { "type": [ "string", "null" ], "description": "время окончания обхода
дата и время завершения обхода
в формате 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" }, "extended_crawl_status": { "type": [ "string", "null" ], "description": "статус и ошибки обхода
указывает причину, по которой сайт не был обойдён;
может принимать следующие значения:
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 - причина неизвестна" }, "ssl_info": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_SslInfo" } ], "description": "информация о SSL-сертификате
информация о протоколе Secure Sockets Layer, обнаруженном на сайте" }, "checks": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "boolean", "null" ] }, "description": "проверки сайта
прочие проверки страницы, связанные с сайтом" }, "total_pages": { "type": [ "integer", "null" ], "description": "всего обойдено страниц
общее количество обойдённых страниц", "format": "int64" }, "total_uncrawlable_resources": { "type": [ "integer", "null" ], "description": "всего необойдённых ресурсов
общее количество ресурсов, которые не удалось обойти;
ресурс считается необойдённым, если фактический тип контента ресурса не соответствует типу контента, ожидаемому краулером", "format": "int64" }, "page_not_found_status_code": { "type": [ "integer", "null" ], "description": "код состояния, возвращённый несуществующей страницей
в большинстве случаев сервер должен возвращать код ответа 404" }, "canonicalization_status_code": { "type": [ "integer", "null" ], "description": "код состояния, возвращённый канонизированной страницей
проверка поведения сервера, когда наш краулер пытается обратиться к сайту по IP;
в большинстве случаев канонизированные страницы должны отвечать кодом состояния 301 или 302" }, "directory_browsing_status_code": { "type": [ "integer", "null" ], "description": "код состояния, возвращённый каталогом
код состояния, возвращённый страницей каталога на целевом сайте
в большинстве случаев каталоги должны отвечать кодом состояния 403 или 401" }, "www_redirect_status_code": { "type": [ "integer", "null" ], "description": "код состояния перенаправления
код состояния перенаправления с www на без www
в большинстве случаев перенаправление должно возвращать код состояния 301" }, "main_domain": { "type": [ "string", "null" ], "description": "корневое доменное имя" } } } ``` ### Response36Afe1097B20_OnPageSummaryResponseInfo `#/components/schemas/Response36Afe1097B20_OnPageSummaryResponseInfo` ```json { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_OnPageSummaryTaskInfo" } ] }, "description": "массив задач" } } } ] } ``` ### Response36Afe1097B20_OnPageSummaryResultInfo `#/components/schemas/Response36Afe1097B20_OnPageSummaryResultInfo` ```json { "type": "object", "properties": { "crawl_progress": { "type": [ "string", "null" ], "description": "статус сеанса сканирования
возможные значения: in_progress, finished" }, "crawl_status": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo" } ], "description": "сведения о сеансе сканирования" }, "crawl_gateway_address": { "type": [ "string", "null" ], "description": "IP-адрес сканера
показывает IP-адрес, использованный сканером для запуска текущего сеанса сканирования
полный список IP-адресов, используемых нашим сканером, приведён в разделе обзора" }, "crawl_stop_reason": { "type": [ "string", "null" ], "description": "причина остановки сканирования
информация о причине остановки процесса сканирования;
возможные значения:
limit_exceeded — превышен лимит, заданный в max_crawl_pages;
empty_queue — все URL в очереди просканированы;
force_stopped — процесс сканирования остановлен с помощью функции On Page API Force Stop;
unexpected_exception — при сканировании target возникла внутренняя ошибка; обратитесь в поддержку за подробностями" }, "domain_info": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DomainInfo" } ], "description": "информация по всему домену
информация OnPage о целевом домене и процессе сканирования" }, "page_metrics": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_PageMetrics" } ], "description": "информация по страницам
информация о метриках страниц целевого сайта" } } } ``` ### Response36Afe1097B20_OnPageSummaryTaskInfo `#/components/schemas/Response36Afe1097B20_OnPageSummaryTaskInfo` ```json { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_OnPageSummaryResultInfo" } ] }, "description": "массив результатов" } } } ] } ``` ### Response36Afe1097B20_PageMetrics `#/components/schemas/Response36Afe1097B20_PageMetrics` ```json { "type": "object", "properties": { "links_external": { "type": [ "integer", "null" ], "description": "количество внешних ссылок
количество ссылок, ведущих на другие сайты" }, "links_internal": { "type": [ "integer", "null" ], "description": "количество внутренних ссылок
количество ссылок, ведущих на другие страницы в пределах целевого сайта" }, "duplicate_title": { "type": [ "integer", "null" ], "description": "количество страниц с дублированными заголовками" }, "duplicate_description": { "type": [ "integer", "null" ], "description": "количество страниц с дублированными описаниями" }, "duplicate_content": { "type": [ "integer", "null" ], "description": "количество страниц с дублированным контентом" }, "broken_links": { "type": [ "integer", "null" ], "description": "количество битых ссылок
количество битых ссылок на всех просканированных страницах целевого сайта" }, "broken_resources": { "type": [ "integer", "null" ], "description": "количество битых ресурсов
количество изображений и других ресурсов с битыми ссылками" }, "links_relation_conflict": { "type": [ "integer", "null" ], "description": "количество ссылок на целевом сайте, которые могут конфликтовать
например, если \"links_relation_conflict\": 2, целевой сайт ссылается на один и тот же источник как минимум одной внутренней ссылкой с атрибутом rel=\"nofollow\" и как минимум одной dofollow-ссылкой" }, "redirect_loop": { "type": [ "integer", "null" ], "description": "количество цепочек перенаправлений, начинающихся и заканчивающихся на одном URL
количество цепочек перенаправлений, в которых целевой URL перенаправляет обратно на исходный URL" }, "onpage_score": { "type": [ "number", "null" ], "description": "показывает, насколько сайт оптимизирован по 100-балльной шкале
это поле показывает, насколько сайт оптимизирован с учётом обнаруженных критических проблем и предупреждений;
100 — максимально возможная оценка, означающая, что на сайте нет критических проблем и важных предупреждений;
обратите внимание, что это значение зависит от количества просканированных страниц;
подробнее о расчёте метрики — в этой статье справочного центра" }, "non_indexable": { "type": [ "integer", "null" ], "description": "количество страниц, недоступных для индексации
количество страниц, которые Google и другие поисковые системы не индексируют из-за настроек robots.txt, HTTP-заголовков или метатегов;
список URL, недоступных для индексации, можно получить с помощью этого эндпоинта" }, "checks": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "integer", "null" ], "format": "int64" }, "description": "проверки OnPage по отдельным страницам" } } } ``` ### Response36Afe1097B20_SslInfo `#/components/schemas/Response36Afe1097B20_SslInfo` ```json { "type": "object", "properties": { "valid_certificate": { "type": [ "boolean", "null" ], "description": "срок действия SSL-сертификата
указывает, не является ли обнаруженный на веб-сайте SSL-сертификат просроченным, приостановленным, отозванным или недействительным" }, "certificate_issuer": { "type": [ "string", "null" ], "description": "центр сертификации SSL
субъект, выдавший обнаруженный SSL-сертификат" }, "certificate_subject": { "type": [ "string", "null" ], "description": "субъект SSL-сертификата
субъект, связанный с открытым ключом" }, "certificate_version": { "type": [ "integer", "null" ], "description": "версия SSL-сертификата
указывает версию X.509, используемую SSL-сертификатом" }, "certificate_hash": { "type": [ "string", "null" ], "description": "хеш SSL-сертификата
версия хеш-функции SSL-сертификата" }, "certificate_expiration_date": { "type": [ "string", "null" ], "description": "дата истечения срока действия SSL-сертификата
дата и время истечения срока действия SSL-сертификата
в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”
пример:
2019-11-15 12:57:46 +00:00" } } } ```