https://dataforseo.com/"
},
"for_mobile": {
"type": [
"boolean",
"null"
],
"description": "применять мобильную эмуляциюtrue, Lighthouse будет использовать эмуляцию мобильного устройства и экрана для проверки страницы в мобильной средеfalse, результаты будут предоставлены для настольного компьютераfalse"
},
"categories": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "категории аудитов Lighthouseauditsвозможные значения:seo, performance, best_practices, accessibility"
},
"audits": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "аудиты Lighthouse
необязательное поле
аудиты — это отдельные тесты, которые Lighthouse выполняет для каждого конкретного компонента/оптимизации/метрики, чтобы получить числовую оценку (см. официальное определение)если проигнорировать это поле, мы вернём данные по всем аудитам
используйте это поле, чтобы получить данные по указанным здесь конкретным аудитам
примечание: некоторые аудиты не относятся к конкретной категории и представляют собой отдельные измерения качества страницы
в целом возможны несколько вариантов использования:
1. если проигнорировать categories, это поле позволяет получить данные только по указанным аудитам
например, если проигнорировать \"categories\" и указать \"audits\": [\"metrics/cumulative-layout-shift\",\"metrics/largest-contentful-paint\",\"metrics/total-blocking-time\"], вы получите данные только по этим аудитам
2. если указать категорию, это поле позволяет дополнительно получить аудиты, не относящиеся к указанным категориям
например, если указать \"categories\": [\"seo\"] и \"audits\": [\"metrics/cumulative-layout-shift\",\"metrics/largest-contentful-paint\",\"metrics/total-blocking-time\"], вы получите только эти аудиты в разделе \"performance\" и все аудиты в разделе \"seo\"
полный список возможных аудитов можно получить здесь"
},
"version": {
"type": [
"string",
"null"
],
"description": "версия Lighthouse
необязательное поле
можно получить результаты, относящиеся к определённой версии Lighthouse, указав её номер
список доступных версий доступен через эндпоинт Lighthouse Versions"
},
"language_name": {
"type": [
"string",
"null"
],
"description": "название языка Lighthouse
необязательное поле
список доступных языков поисковой системы с их language_name можно получить, отправив отдельный запрос к https://api.dataforseo.com/v3/on_page/lighthouse/languages
значение по умолчанию:English"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "код языка Lighthouse
необязательное поле
список доступных языков поисковой системы с их language_code можно получить, отправив отдельный запрос к https://api.dataforseo.com/v3/on_page/lighthouse/languages
значение по умолчанию:en"
},
"custom_user_agent": {
"type": [
"string",
"null"
],
"description": "пользовательский user agent
необязательное поле
укажите пользовательский user agent, используемый браузером при выполнении аудита Lighthouse;
можно указать до 254 символов;"
},
"browser_screen_width": {
"type": [
"integer",
"null"
],
"description": "ширина экрана браузера
необязательное поле
задайте ширину экрана браузера, используемого для аудита Lighthouse, чтобы эмулировать конкретное устройство;
можно указать в следующем диапазоне: 240–9999;",
"format": "int64"
},
"browser_screen_height": {
"type": [
"integer",
"null"
],
"description": "высота экрана браузера
необязательное поле
задайте высоту экрана браузера, используемого для аудита Lighthouse, чтобы эмулировать конкретное устройство;
можно указать в следующем диапазоне: 240–9999;"
},
"browser_screen_scale_factor": {
"type": [
"number",
"null"
],
"description": "масштаб экрана браузера
необязательное поле
задайте соотношение пикселей устройства браузера, используемого для аудита Lighthouse;
можно указать в следующем диапазоне: 0.5–3;"
},
"browser_network_throttling_method": {
"type": [
"string",
"null"
],
"description": "метод сетевого троттлинга браузера
необязательное поле
определяет метод применения троттлинга во время аудита Lighthouse;
возможные значения:simulate - рассчитывает оценочные метрики производительности без явного применения троттлинга;devtools - применяет настройки троттлинга, указанные в browser_network_throttling и browser_cpu_throttling_multiplier;provided - использует сетевые условия среды обхода;"
},
"browser_cpu_throttling_multiplier": {
"type": [
"number",
"null"
],
"description": "множитель троттлинга CPU браузера
обязательно, если для browser_network_throttling_method задано значение devtools;
задайте множитель троттлинга CPU для имитации условий производительности устройства во время аудита Lighthouse;
можно указать в следующем диапазоне: 1–4;
Примечание: этот параметр применяется, только когда для browser_network_throttling_method задано значение devtools;"
},
"browser_network_throttling": {
"type": [
"string",
"null"
],
"description": "сетевой троттлинг браузера
обязательно, если для browser_network_throttling_method задано значение devtools;
задайте профиль сетевого троттлинга для имитации условий скорости соединения во время аудита Lighthouse;
возможные значения: no_throttling, fast_4g, slow_4g, regular_3g, pc;
Примечание: этот параметр применяется, только когда для browser_network_throttling_method задано значение devtools;"
},
"tag": {
"type": [
"string",
"null"
],
"description": "пользовательский идентификатор задачи
необязательное поле
ограничение — 255 символов
этот параметр позволяет идентифицировать задачу и сопоставить её с результатом
указанное значение tag вы найдёте в объекте data ответа"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "URL уведомления о завершённой задаче
необязательное поле
по завершении задачи мы отправим GET-запрос на указанный вами URL
строку ‘$id’ можно использовать как переменную $id, а ‘$tag’ — как urlencoded-переменную $tag. Перед отправкой запроса мы подставим нужные значения.
пример:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Примечание: специальные символы в pingback_url будут urlencoded;
в частности, символ # будет закодирован как %23. Подробнее в нашем Help Center"
}
},
"example": [
{
"url": "https://dataforseo.com",
"for_mobile": true,
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
}
]
},
"example": [
{
"url": "https://dataforseo.com",
"for_mobile": true,
"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_OnPageLighthouseTaskPostResponseInfo"
}
]
}
```
### 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_OnPageLighthouseTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_OnPageLighthouseTaskPostResponseInfo`
```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_OnPageLighthouseTaskPostTaskInfo"
}
]
},
"description": "массив задач"
}
}
}
]
}
```
### Response36Afe1097B20_OnPageLighthouseTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_OnPageLighthouseTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
}
}
}
}
}
]
}
```