# Водопад OnPage API

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/on_page/waterfall`

**Tags:** DataForSEO

Тайминги загрузки одного обойдённого `url`: что запрашивалось, в каком порядке и сколько заняло. Читает завершённый обход, поэтому нужен `id` из `post_dataforseo_on_page_submit`, и возвращает `crawl_progress` и `crawl_status` со значениями `max_crawl_pages`, `pages_in_queue` и `pages_crawled` — проверяйте их, прежде чем доверять небольшому результату: у ещё идущего обхода просто меньше данных. Используйте, чтобы объяснить медленную страницу; для аудита производительности с оценками возьмите `post_dataforseo_on_page_lighthouse_live_json`. 💰 Бесплатно на стороне 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`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "<em>ID задачи</em><br><strong>обязательное поле</strong><br>этот ID можно получить в ответе эндпоинта <a href=\"/v3/on_page/task_post/\">Task POST</a><br>пример:<br>\"07131248-1535-0216-1000-17384017ad04\""
          },
          "url": {
            "type": "string",
            "description": "<em>URL страницы</em><br><strong>обязательное поле</strong><br>укажите страницы, для которых нужно получить тайминги"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "id": "08101204-0696-0216-0000-644a7b21a48a",
            "url": "https://dataforseo.com/tag/broken-links"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "id": "08101204-0696-0216-0000-644a7b21a48a",
      "url": "https://dataforseo.com/tag/broken-links"
    }
  ]
}
```

## Responses

### 200 — Успешная операция

Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_OnPageWaterfallResponseInfo"
    }
  ]
}
```

### 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_OnPageResourceLocationInfo

`#/components/schemas/Response36Afe1097B20_OnPageResourceLocationInfo`

```json
{
  "type": "object",
  "properties": {
    "line": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>номер строки</em><br>номер строки, в которой находится ресурс"
    },
    "offset_left": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>позиция в строке</em><br>количество символов строки перед ресурсом;<br>иногда называется <em>столбцом</em><br><strong>Примечание:</strong> отсчёт начинается с 1, то есть если слева от ресурса нет символов, значение будет 1"
    },
    "offset_top": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>позиция в документе</em><br>общее количество символов между ресурсом и началом HTML"
    }
  }
}
```

### Response36Afe1097B20_OnPageWaterfallItem

`#/components/schemas/Response36Afe1097B20_OnPageWaterfallItem`

```json
{
  "type": "object",
  "properties": {
    "page_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>URL страницы</em>"
    },
    "time_to_interactive": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>метрика <a href=\"https://web.dev/interactive/\">Time To Interactive (TTI)</a></em><br>время до того, как пользователь сможет взаимодействовать со страницей (в миллисекундах)"
    },
    "dom_complete": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время загрузки ресурсов</em><br>время до загрузки страницы и всех её подресурсов (в миллисекундах)"
    },
    "connection_time": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время подключения к серверу</em><br>время до установления соединения с сервером (в миллисекундах)"
    },
    "time_to_secure_connection": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время установления защищённого соединения</em><br>время до установления защищённого соединения с сервером (в миллисекундах)"
    },
    "request_sent_time": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время отправки запроса на сервер</em><br>время до отправки запроса на сервер (в миллисекундах)"
    },
    "waiting_time": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время до первого байта <a href=\"https://en.wikipedia.org/wiki/Time_to_first_byte\">(TTFB)</a> в миллисекундах</em>"
    },
    "download_time": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время получения ответа браузером (в миллисекундах)</em>"
    },
    "duration_time": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>общее время до получения браузером полного ответа от сервера (в миллисекундах)</em>"
    },
    "fetch_start": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время начала загрузки HTML-ресурса</em><br>время, необходимое браузеру для начала загрузки страницы"
    },
    "fetch_end": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время завершения загрузки HTML-ресурса</em><br>время, необходимое браузеру для завершения загрузки страницы"
    },
    "resources": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_WaterfallResourceInfo"
          }
        ]
      },
      "description": "<em>тайминги по ресурсам</em><br>содержит отдельные массивы с таймингами для каждого ресурса, найденного на странице"
    }
  }
}
```

### Response36Afe1097B20_OnPageWaterfallResponseInfo

`#/components/schemas/Response36Afe1097B20_OnPageWaterfallResponseInfo`

```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_OnPageWaterfallTaskInfo"
              }
            ]
          },
          "description": "<em>массив задач</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_OnPageWaterfallResultInfo

`#/components/schemas/Response36Afe1097B20_OnPageWaterfallResultInfo`

```json
{
  "type": "object",
  "properties": {
    "crawl_progress": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>статус сеанса сканирования</em><br>возможные значения: <code>in_progress</code>, <code>finished</code>"
    },
    "crawl_status": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
        }
      ],
      "description": "<em>сведения о сеансе сканирования</em>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество элементов в массиве результатов</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_OnPageWaterfallItem"
          }
        ]
      },
      "description": "<em>массив элементов</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageWaterfallTaskInfo

`#/components/schemas/Response36Afe1097B20_OnPageWaterfallTaskInfo`

```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_OnPageWaterfallResultInfo"
              }
            ]
          },
          "description": "<em>массив результатов</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_WaterfallResourceInfo

`#/components/schemas/Response36Afe1097B20_WaterfallResourceInfo`

```json
{
  "type": "object",
  "properties": {
    "resource_type": {
      "type": [
        "string",
        "null"
      ]
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>URL ресурса</em>"
    },
    "initiator": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>инициатор ресурса</em>"
    },
    "duration_time": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>общее время до получения браузером полного ответа от сервера (в миллисекундах)</em>"
    },
    "fetch_start": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время начала загрузки HTML-ресурса</em><br>время, необходимое браузеру для начала загрузки страницы"
    },
    "fetch_end": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>время завершения загрузки HTML-ресурса</em><br>время, необходимое браузеру для завершения загрузки страницы"
    },
    "location": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_OnPageResourceLocationInfo"
        }
      ],
      "description": "<em>расположение ресурса в документе</em><br>параметры, определяющие расположение конкретного ресурса в HTML-коде документа"
    },
    "is_render_blocking": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>указывает, блокирует ли ресурс рендеринг</em>"
    }
  }
}
```