Cтатистика по проекту

Запрос позволяет получить статистику по запросам к API за период времени. Максимальный период в одном запросе — 35 дней. Ограничение по частоте использования: 1 запрос в 10 секунд.

Формат запроса

Чтобы получить статистику по проекту, используйте HTTP-запрос с методом GET:

GET /projects/<project_id>/services/<service_id>/statistic?start=<YYYY-MM-DD>&end=<YYYY-MM-DD>
Host: api-developer.tech.yandex.net
X-Auth-Key: <ваш API-ключ>
Ресурс

<project_id>

Идентификатор проекта.

<service_id>

Идентификатор сервиса.

start

Начальная дата периода.

end

Конечная дата периода.

Заголовки запроса

Host

Адрес узла, предоставляющего API.

X-Auth-Key

Ключ авторизации.

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит объект в формате JSON:

{
    "statistic": [
        {
            "counters": {
                "cells": 50,
                "orders": 10,
                "requests": 2,
                "requests_router": 8,
                "total": 10
            },
            "date": "2021-10-01"
        },
        {
            "counters": {
                "cells": 43,
                "orders": 15,
                "requests": 4,
                "requests_router": 9,
                "total": 13
            },
            "date": "2021-10-02"
        },
        ...
    ]
}

Свойства ответа

Ключ

Значение

statistic

Массив со статистикой по дням.

Свойства массива statistic

counters

Объект с названиями и значениями счетчиков за сутки.

date

Дата.

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

HTTP-код ошибки

Описание ошибки

400 Bad Request

Один из параметров запроса имеет недопустимое значение или формат данных.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

404 Not Found

Запрашиваемый ресурс не найден.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

503 Service Unavailable

Сервис API временно недоступен.