Tráfego

GET /api/analytics/traffic

Largura de banda diária de CDN e armazenamento para o workspace, em bytes. Estes valores medem a entrega, não a reprodução reportada pelo player.

Exige analytics.read. Vê Visão geral para autenticação e âmbito de categoria. Este endpoint é de todo o workspace. Não aceita um id de vídeo.

Parâmetros

Parâmetro	Obrigatório	Descrição
`startDate`	Sim	Início do intervalo. ISO 8601 ou `YYYY-MM-DD`. Inclusivo.
`endDate`	Sim	Fim do intervalo. ISO 8601 ou `YYYY-MM-DD`. Inclusivo.

O Ignite trata startDate como o início desse dia de calendário e endDate como o fim desse dia de calendário. A resposta inclui no máximo 999 dias, os mais recentes primeiro.

Pedido

CURL


curl -X GET "https://app.ignitevideo.cloud/api/analytics/traffic?startDate=2026-08-01&endDate=2026-08-31" \
-H "Authorization: Bearer YOUR_API_KEY"

JavaScript / Node.js


const response = await fetch(
'https://app.ignitevideo.cloud/api/analytics/traffic?startDate=2026-08-01&endDate=2026-08-31',
{ headers: { Authorization: `Bearer YOUR_API_KEY` } }
);
const data = await response.json();

PHP


$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://app.ignitevideo.cloud/api/analytics/traffic', [
'query' => ['startDate' => '2026-08-01', 'endDate' => '2026-08-31'],
'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
]);

Resposta

O body é uma lista paginada (vê Consultas). Usa docs para as linhas diárias.


{
  "docs": [
    {
      "id": string,
      "date": string,
      "incomingTraffic": number,
      "outgoingTraffic": number,
      "totalTraffic": number,
      "workspace": string,
      "createdAt": string,
      "updatedAt": string
    },
    [...]
  ],
  "totalDocs": number,
  "limit": number,
  "page": number,
  "totalPages": number,
  "hasNextPage": boolean,
  "hasPrevPage": boolean
}

Field	Descrição
`incomingTraffic`	Bytes carregados para o armazenamento nesse dia.
`outgoingTraffic`	Bytes entregues aos espetadores nesse dia. A Admin UI mostra este campo no gráfico.
`totalTraffic`	`incomingTraffic` + `outgoingTraffic`.

Todos os campos de tráfego são inteiros em bytes. Converte-os para apresentação. Por exemplo, 1000000000 bytes são 1 GB.

Erros

Estado	Body	Significado
`400`	Texto simples	`startDate` / `endDate` em falta ou inválido
`403`	—	Falta `analytics.read` ou chave desativada