Trafic

GET /api/analytics/traffic

Bande passante quotidienne CDN et stockage pour l’espace de travail, en octets. Ces valeurs mesurent la livraison, pas la lecture rapportée par le player.

Nécessite analytics.read. Voir Vue d’ensemble pour l’authentification et le périmètre de catégories. Cet endpoint couvre tout l’espace de travail. Il n’accepte pas d’id vidéo.

Paramètres

Paramètre	Requis	Description
`startDate`	Oui	Début de la plage. ISO 8601 ou `YYYY-MM-DD`. Inclus.
`endDate`	Oui	Fin de la plage. ISO 8601 ou `YYYY-MM-DD`. Inclus.

Ignite traite startDate comme le début de ce jour calendaire et endDate comme la fin de ce jour calendaire. La réponse contient au plus 999 jours, les plus récents en premier.

Requête

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'],
]);

Réponse

Le body est une liste paginée (voir Interrogation). Utilise docs pour les lignes quotidiennes.


{
  "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	Description
`incomingTraffic`	Octets téléchargés vers le stockage ce jour-là.
`outgoingTraffic`	Octets livrés aux spectateurs ce jour-là. L’Admin UI affiche ce champ dans le graphique.
`totalTraffic`	`incomingTraffic` + `outgoingTraffic`.

Tous les champs de trafic sont des entiers en octets. Convertis-les pour l’affichage. Par exemple, 1000000000 octets font 1 Go.

Erreurs

Status	Body	Signification
`400`	Texte brut	`startDate` / `endDate` manquant ou invalide
`403`	—	`analytics.read` manquant ou clé désactivée