Глоссарий

Каждый термин в документации означает одно и то же на всех страницах.

Аккаунт — учётная запись в панели. Ключи, каналы, запуски, заказы и счёт принадлежат аккаунту.

Ключ — строка, которой подписываются запросы к API. Выпускается в панели и принадлежит аккаунту. См. Аутентификация.

Право — разрешение ключа на изменения: channels, viewers, chat_panel, billing. Чтение доступно любому ключу. См. Права ключей.

Лимит — личный лимит аккаунта: пулы по площадкам, число каналов и срок действия. См. Лимит и занятость пула.

Пул — сколько зрителей аккаунт может держать одновременно на одной площадке. У Twitch и Kick пулы раздельные.

Занято — сколько мест пула занимают работающие запуски (busy).

Резерв — сколько мест пула занимает один работающий запуск: сколько зрителей ему разрешено держать, а для запуска с графиком — наибольшее значение графика.

Канал — канал на Twitch или Kick, заведённый в аккаунте, с потолком и настройками.

Потолок канала — наибольшее число зрителей, которое можно запустить на канале (viewers у канала).

Разовый канал — канал для одного запуска с заданным сроком. Удаляется вместе со своим запуском. См. Разовый запуск.

Запуск — зрители, работающие на канале. У канала бывает не больше одного запуска. Запуск ждёт эфира (waiting) или работает (running).

Разгон — постепенный набор зрителей до заказанного числа в начале эфира.

Плавающий онлайн — периодические колебания числа зрителей вокруг заданного.

График онлайна — заданное по минутам эфира число зрителей. Создаётся в панели и назначается каналу в настройках.

Автопросмотры — просмотры, которые начисляются автоматически во время эфира из расчёта на одного зрителя и оплачиваются поминутно со счёта. Включаются только в панели.

Заказ — услуга, оплаченная со счёта: просмотры, фолловеры, чат-боты, чат-панель.

Событие — запись о том, что случилось с объектом аккаунта: запуск вышел на канал, заказ выполнен, срок подходит к концу. См. События.

Ставка — цена единицы услуги для вашего аккаунта с наценкой и скидками, в копейках (unit_amount_decimal).

Счёт — баланс аккаунта, с которого оплачиваются заказы и автопросмотры.

Операция — движение денег по счёту: пополнение, списание, возврат, корректировка.

Суточный потолок трат — наибольшая сумма, которую ключ с правом billing может потратить за сутки по московскому времени.

Ключ идемпотентности — значение заголовка Idempotency-Key, по которому повтор запроса не выполняется второй раз. См. Идемпотентность.