Необходимые cookie-файлы нужны для работы сайта. Аналитические cookie (Яндекс Метрика) — только с вашего согласия. Политика cookie-файлов

Тема оформления
СправочникСправочник APIБиллинг

Прогоны и оплаченные страницы за период

Прогоны, созданные в период [from, to] (целые дни по Москве), по дням, типизаторам или ключам API. Не больше 366 дней (иначе 400, param: to). Дни без прогонов не выводятся. Демо-прогоны не учитываются. Доступ: ключ API со скоупом billing:read или сессия.

GET/v1/usageПесочница

Авторизация

Проверяем сессию Кабинета…

Параметры

string · date

Первый день (по Москве), включительно.

string · date

Последний день (по Москве), включительно.

stringпо умолчанию day

Разбивка: по дням, типизаторам или ключам

Проверяем сессию Кабинета…

Authorization

headerAuthorizationBearer <token>

Ключ API (tz_live_…). Если операция требует скоупы, они нужны ключу; у сессии есть все скоупы.

Query Parameters

from?string

Первый день (по Москве), включительно. По умолчанию — 30 дней назад, считая to

Formatdate
to?string

Последний день (по Москве), включительно. По умолчанию — сегодня по Москве

Formatdate
group_by?string
Default"day"
Value in"day""typizer""key"

Header Parameters

Typizer-Organization?string

Организация, от имени которой выполняется запрос (org_…). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.

Response Body

Расход

application/json
  1. response
object*"usage"
Value in"usage"
from*string
Formatdate
to*string
Formatdate
group_by*string
Value in"day""typizer""key"
data*array<>
has_more*boolean

Групп больше 1000; в data — самые крупные по оплаченным страницам

curl -X GET 'https://api.typizer.ru/v1/usage'
Example Response
{  "object": "usage",  "from": "2019-08-24",  "to": "2019-08-24",  "group_by": "day",  "data": [    {      "key": "string",      "runs": 0,      "succeeded": 0,      "failed": 0,      "pages_billed": 0    }  ],  "has_more": true}