Traffic

GET /api/analytics/traffic

Daily CDN and storage bandwidth for the workspace, in bytes. These values measure delivery, not player-reported playback.

Requires analytics.read. See Overview for authentication and category scope. This endpoint is workspace-wide. It does not accept a video id.

Parameters

Parameter	Required	Description
`startDate`	Yes	Start of the range. ISO 8601 or `YYYY-MM-DD`. Inclusive.
`endDate`	Yes	End of the range. ISO 8601 or `YYYY-MM-DD`. Inclusive.

Ignite treats startDate as the start of that calendar day and endDate as the end of that calendar day. The response includes at most 999 days, newest first.

Request

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

Response

The body is a paginated list (see Querying). Use docs for the daily rows.


{
  "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`	Bytes uploaded to storage that day.
`outgoingTraffic`	Bytes delivered to viewers that day. The Admin UI charts this field.
`totalTraffic`	`incomingTraffic` + `outgoingTraffic`.

All traffic fields are integers in bytes. Convert them for display. For example, 1000000000 bytes is 1 GB.

Errors

Status	Body	Meaning
`400`	Plain text	Missing or invalid `startDate` / `endDate`
`403`	—	Missing `analytics.read` or a disabled key