https:// и www.max_crawl_pages = 1 и не указывать start_url или указать в нём домашнюю страницу, следующие проверки всего сайта будут отключены:test_canonicalization, enable_www_redirect_check, test_hidden_server_signature, test_page_not_found, test_directory_browsing, test_https_redirectforce_sitewide_checks в trueесли задать max_crawl_pages = 1 и указать в start_url не домашнюю страницу, все проверки всего сайта будут отключены;force_sitewide_checks в true"
},
"start_url": {
"type": [
"string",
"null"
],
"description": "первый URL для обхода max_crawl_pages в 1true, чтобы получать данные проверок всего сайта при обходе одной страницы;false"
},
"priority_urls": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "URL для обхода вне очередиtarget;allow_subdomains не установлен в trueпример:2000"
},
"store_raw_html": {
"type": [
"boolean",
"null"
],
"description": "сохранять HTML обойдённых страницtrue, чтобы получать HTML страницы через эндпоинт OnPage Raw HTMLfalse"
},
"enable_content_parsing": {
"type": [
"boolean",
"null"
],
"description": "разбор контента обойдённых страницtrue, чтобы использовать эндпоинт OnPage Content Parsingfalse"
},
"support_cookies": {
"type": [
"boolean",
"null"
],
"description": "поддержка cookie на обходимых страницахtrue, чтобы поддерживать cookie при обходе страницfalse"
},
"accept_language": {
"type": [
"string",
"null"
],
"description": "языковой заголовок для доступа к веб-сайту\"type\":\"broken в массиве ответа"
},
"custom_robots_txt": {
"type": [
"string",
"null"
],
"description": "пользовательские настройки robots.txtDisallow: /directory1/"
},
"robots_txt_merge_mode": {
"type": [
"string",
"null"
],
"description": "объединение с настройками robots.txt или их переопределениеmerge, override;override, если хотите игнорировать ограничения обхода сайта и другие настройки robots.txtmerge;override, укажите параметр custom_robots_txt"
},
"custom_user_agent": {
"type": [
"string",
"null"
],
"description": "пользовательский user agentMozilla/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)"
},
"browser_preset": {
"type": [
"string",
"null"
],
"description": "пресет параметров экрана браузераbrowser_screen_width, browser_screen_height, browser_screen_scale_factor не нужно. возможные значения:desktop, mobile, tabletdesktop пресет применяет следующие значения:browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile пресет применяет следующие значения:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet пресет применяет следующие значения:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2enable_javascript или enable_browser_rendering значение true"
},
"browser_screen_width": {
"type": [
"integer",
"null"
],
"description": "ширина экрана браузераbrowser_preset не нужно, так как он будет проигнорирован;enable_javascript или enable_browser_rendering значение true минимальное значение в пикселях: 2409999",
"format": "int64"
},
"browser_screen_height": {
"type": [
"integer",
"null"
],
"description": "высота экрана браузераbrowser_preset не нужно, так как он будет проигнорирован;enable_javascript или enable_browser_rendering значение true минимальное значение в пикселях: 2409999"
},
"browser_screen_scale_factor": {
"type": [
"number",
"null"
],
"description": "масштаб экрана браузераbrowser_preset не нужно, так как он будет проигнорирован;enable_javascript или enable_browser_rendering значение true минимальное значение: 0.53"
},
"respect_sitemap": {
"type": [
"boolean",
"null"
],
"description": "соблюдать sitemap при обходеtrue, чтобы при обходе следовать порядку страниц, указанному в основном sitemap;falsetrue, значение click_depth в ответе API будет равно 0;max_crawl_depth запроса будет проигнорировано; количество обходимых страниц можно задать параметром max_crawl_pages"
},
"custom_sitemap": {
"type": [
"string",
"null"
],
"description": "URL пользовательского sitemaprespect_sitemap должен быть true"
},
"crawl_sitemap_only": {
"type": [
"boolean",
"null"
],
"description": "обходить только страницы, указанные в sitemaptrue, чтобы обходить только страницы, указанные в sitemaptrue и не указывать custom_sitemap, мы обойдём sitemap по умолчаниюfalserespect_sitemap должен быть true"
},
"load_resources": {
"type": [
"boolean",
"null"
],
"description": "загружать ресурсыtrue, чтобы загружать изображения, таблицы стилей, скрипты и недоступные ресурсыfalsetrue, чтобы проверить, настроена ли на запрошенном домене переадресация с www на без-www или с без-www на www;false"
},
"enable_javascript": {
"type": [
"boolean",
"null"
],
"description": "загружать javascript на страницеtrue, чтобы загружать скрипты, доступные на страницеfalsetrue, чтобы наш краулер запрашивал данные с веб-сервера через объект XMLHttpRequestfalse;если вы используете это поле, enable_javascript должен быть установлен в true;"
},
"enable_browser_rendering": {
"type": [
"boolean",
"null"
],
"description": "эмуляция браузера для измерения Core Web Vitalsenable_browser_rendering загружает стили, изображения, шрифты, анимации, видео и другие ресурсы страницы;falsetrue, чтобы получать в ответе метрики Core Web Vitals (FID, CLS, LCP);enable_javascript и load_resources должны быть установлены в truetrue, чтобы отключить всплывающее окно с запросом согласия на использование cookie;false"
},
"custom_js": {
"type": [
"string",
"null"
],
"description": "пользовательский javascriptscr:let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i < document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute(\"src\");rn if (src != undefined) {rn if (src.indexOf(\"analytics.js\") >= 0)rn meta.haveGoogleAnalytics = true;rntif (src.indexOf(\"gtm.js\") >= 0)rn meta.haveTagManager = true;rn }rn}rnmeta;Возвращаемое значение зависит от того, что вы указали в этом поле. Например, если указать такой скрипт:true, чтобы использовать эндпоинт OnPage API Microdatafalse"
},
"allow_subdomains": {
"type": [
"boolean",
"null"
],
"description": "включать страницы на поддоменахtrue, если хотите обходить все поддомены целевого веб-сайтаfalse"
},
"allowed_subdomains": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "поддомены для обхода[\"blog.site.com\", \"my.site.com\", \"shop.site.com\"]allow_subdomains должен иметь значение false;allowed_subdomains будет проигнорировано, и результаты будут возвращены для всех поддоменов"
},
"disallowed_subdomains": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "поддомены, которые не нужно обходить[\"status.site.com\", \"docs.site.com\"]allow_subdomains должен быть установлен в true"
},
"check_spell": {
"type": [
"boolean",
"null"
],
"description": "проверять орфографиюtrue, чтобы проверять орфографию на веб-сайте с помощью библиотеки Hunspellfalse"
},
"check_spell_language": {
"type": [
"string",
"null"
],
"description": "язык проверки орфографии\"SERP\", \"minifiers\", \"JavaScript\""
},
"calculate_keyword_density": {
"type": [
"boolean",
"null"
],
"description": "рассчитывать плотность ключевых слов для целевого доменаtrue, если хотите рассчитать плотность ключевых слов для страниц веб-сайтаfalsechecks ответов OnPage API;high_loading_time и large_page_size по умолчанию равны 3 секундам и 1 мегабайту соответственно;checks, чтобы они не выполнялись на сайте target:\"test_page_not_found\"\"test_canonicalization\"\"test_https_redirect\"\"test_directory_browsing\"пример:\"disable_sitewide_checks\": [\"test_directory_browsing\", \"test_page_not_found\"]подробнее в справочном центре"
},
"disable_page_checks": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "запретить выполнение отдельных проверок страницыchecks, чтобы они не выполнялись и не влияли на onpage_scoreпример:\"disable_page_checks\": [\"is_5xx_code\", \"is_4xx_code\"]"
},
"switch_pool": {
"type": [
"boolean",
"null"
],
"description": "переключение пула проксиtrue, для получения запрошенных данных будут использоваться дополнительные пулы прокси;rate-limit и/или site_unreachable"
},
"return_despite_timeout": {
"type": [
"boolean",
"null"
],
"description": "возвращать данные страниц несмотря на ошибку таймаутаtrue, данные будут предоставлены по страницам, которые не загрузились за 120 секунд и вернули ошибку таймаута;false"
},
"tag": {
"type": [
"string",
"null"
],
"description": "пользовательский идентификатор задачиtag вы найдёте в объекте data ответа"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "URL уведомления о завершении задачи$id, а «$tag» — как urlencoded-переменную $tag. Перед отправкой запроса мы подставим нужные значения.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url будут urlencoded;# кодируется как %23Подробнее см. в Help Center"
}
},
"example": [
{
"target": "dataforseo.com",
"max_crawl_pages": 10,
"load_resources": true,
"enable_javascript": true,
"custom_js": "meta = {}; meta.url = document.URL; meta;",
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
}
]
},
"example": [
{
"target": "dataforseo.com",
"max_crawl_pages": 10,
"load_resources": true,
"enable_javascript": true,
"custom_js": "meta = {}; meta.url = document.URL; meta;",
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
}
```
## Responses
### 200 — Успешная операция
Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageTaskPostResponseInfo"
}
]
}
```
### 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_OnPageTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_OnPageTaskPostResponseInfo`
```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_OnPageTaskPostTaskInfo"
}
]
},
"description": "массив задач"
}
}
}
]
}
```
### Response36Afe1097B20_OnPageTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_OnPageTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"object",
"null"
],
"description": "массив результатов
в этом случае значение будет null"
}
}
}
]
}
```