Общие сведения
Данный API используется для получения статистики использования сервиса оптимизации изображений
Внимание!
- Установлено ограничение на количество обращений к API:
- не больше 5 обращений в минуту.
Описание заголовков запроса:
| Имя заголовка | Описание | Обязательный |
|---|---|---|
| CDN-AUTH-TOKEN | Авторизационный токен | Да |
Описание параметров запроса:
| Имя параметра | Описание | Обязательный |
|---|---|---|
| account | Имя аккаунта | Да |
| fields | Поля, значения которых нужно вернуть | Нет |
| start | Начало периода в формате ISO8601 (включительно) | Да |
| end | Конец периода в формате ISO8601 (не включительно) | Да |
| granularity | Интервал времени в упрощенном формате ISO8601 (P1D, PT8H,...) | Для /times |
| sort | Объект и способ сортировки | Нет |
| offset | Смещение результата | Нет |
| limit | Ограничение результата | Нет |
Описание параметров ответа:
| Имя параметра | Описание |
|---|---|
| start, end | границы интервала |
| account | Имя аккаунта |
| data | Основная информация ответа |
| conversions | Количество выполненных операций |
| requests | Количество запросов к сервису |
| in_bytes | объем входящего трафика за заданный период в байтах |
| out_bytes | объем исходящего трафика за заданный период в байтах |
| in_content_type | Content-Type исходного запроса |
| out_content_type | Content-Type обработанного запроса |
Возможные коды ответа:
| Код ответа | Описание |
|---|---|
| 200 | OK |
| 400 | Неверный запрос |
| 401 | Не авторизован |
| 403 | Доступ запрещен |
| 500 | Внутренняя ошибка сервера |
| 503 | Сервис недоступен |
Общая статистика
Данный вызов используется для получения общей статистики использования сервиса оптимизации изображений за заданный период.
URL: https://apicdn.rcloud.ru/app/ioss-statistic/v1/?account=<your_account_name>&start=2023-01-01T00:00:00Z&end=2023-02-01T00:00:00Z
- Тип запроса: GET
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
Пример запроса
curl -H "CDN-AUTH-TOKEN: $TOKEN" \ 'https://apicdn.rcloud.ru/app/ioss-statistic/v1/?account=testaccount&start=2023-01-02T13:09:00Z&end=2023-03-02T13:10:00Z'
Пример успешного ответа
{ "end": "2023-03-02T13:10:00+00:00", "start": "2023-01-02T13:09:00+00:00", "account": "testaccount", "data": { "conversions": 27585497, "requests": 21921555, "in_bytes": 2443059563686, "out_bytes": 1330836800409 } }
Статистика по операциям
Данный вызов используется для детализации операций по типу
URL: https://apicdn.rcloud.ru/app/ioss-statistic/v1/action?account=<your_account_name>&start=2023-01-01T00:00:00Z&end=2023-02-01T00:00:00Z
- Тип запроса: GET
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
Пример запроса
curl -H "CDN-AUTH-TOKEN: $TOKEN" \ 'https://apicdn.rcloud.ru/app/ioss-statistic/v1/action?account=testaccount&start=2023-01-02T13:09:00Z&end=2023-03-02T13:10:00Z'
Пример успешного ответа
{ "start": "2023-01-02T13:09:00+00:00", "end": "2023-03-02T13:10:00+00:00", "account": "testaccount", "data": [ { "action": "convert", "conversions": 21913945, "in_bytes": 2265285030613, "out_bytes": 344728920647 }, { "action": "quality", "conversions": 5671552, "in_bytes": 597323275534, "out_bytes": 90913935289 } ] }
Статистика по Content-Type
Данные вызовы используются для детализации запросов по in/out content-type
URL: https://apicdn.rcloud.ru/app/ioss-statistic/v1/in-content-type?account=<your_account_name>&start=2023-01-01T00:00:00Z&end=2023-02-01T00:00:00Z
URL: https://apicdn.rcloud.ru/app/ioss-statistic/v1/out-content-type?account=<your_account_name>&start=2023-01-01T00:00:00Z&end=2023-02-01T00:00:00Z
- Тип запроса: GET
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
Пример запроса
curl -H "CDN-AUTH-TOKEN: $TOKEN" \ 'https://apicdn.rcloud.ru/app/ioss-statistic/v1/out-content-type?account=testaccount&start=2023-02-02T13:09:00Z&end=2023-03-02T13:10:00Z'
Пример успешного ответа
{ "start": "2023-02-02T13:09:00+00:00", "end": "2023-03-02T13:10:00+00:00", "account": "testaccount", "data": [ { "out_content_type": "-", "requests": 3120, "in_bytes": 594164, "out_bytes": 697806 }, { "out_content_type": "image/gif", "requests": 969, "in_bytes": 25855686, "out_bytes": 25855788 }, { "out_content_type": "image/jpeg", "requests": 4131912, "in_bytes": 333206022458, "out_bytes": 333188803602 }, { "out_content_type": "image/png", "requests": 1629595, "in_bytes": 504203255765, "out_bytes": 504147453203 }, { "out_content_type": "image/webp", "requests": 7995946, "in_bytes": 839899400734, "out_bytes": 128330988195 }, { "out_content_type": "text/html", "requests": 1378330, "in_bytes": 1725130740, "out_bytes": 1206975546 }, { "out_content_type": "text/plain; charset=utf-8", "requests": 13, "in_bytes": 2509, "out_bytes": 2951 } ] }
Разделение по периодам
Данные вызовы используются для формирования статистики по параметрам, разделенной по временным интервалам.
URL: https://apicdn.rcloud.ru/app/ioss-statistic/v1/times/action?account=<your_account_name>&start=2023-01-01T00:00:00Z&end=2023-02-01T00:00:00Z&granularity=P1W'
- Тип запроса: GET
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
Пример запроса
curl -H "CDN-AUTH-TOKEN: $TOKEN" \ 'https://apicdn.rcloud.ru/app/ioss-statistic/v1/times/action?account=testaccount&start=2023-02-02T13:09:00Z&end=2023-03-02T13:10:00Z&granularity=P1W'
Пример успешного ответа
{ "granularity": "P1W", "start": "2023-02-02T13:09:00+00:00", "end": "2023-03-02T13:10:00+00:00", "account": "testaccount", "data": [ { "start": "2023-02-02T13:09:00+00:00", "end": "2023-02-06T00:00:00+00:00", "data": [ { "action": "quality", "conversions": 0, "in_bytes": 0, "out_bytes": 0 }, { "action": "convert", "conversions": 727108, "in_bytes": 72033704597, "out_bytes": 11632136623 } ] }, {...}, { "start": "2023-02-27T00:00:00+00:00", "end": "2023-03-02T13:10:00+00:00", "data": [ { "action": "quality", "conversions": 987410, "in_bytes": 108687891902, "out_bytes": 16025891848 }, { "action": "convert", "conversions": 987410, "in_bytes": 108687891902, "out_bytes": 16025891848 } ] } ] }