Plays

GET /api/analytics/plays

Totals and a time series of views, watch time, completions, and sessions.

Requires analytics.read. See Overview for shared parameters and category scope.

Parameters

Parameter	Required	Description
`contentType`	No	`vod` (default) or `live`
`contentId`	No	Limit to one video or live event
`interval`	No	`hour` or `day` (default `day`)
`from`, `to`	No	ISO 8601 range
`minimumWatchSeconds`	No	Default `3`

Request

CURL


curl -X GET "https://app.ignitevideo.cloud/api/analytics/plays?interval=day&contentType=vod" \
-H "Authorization: Bearer YOUR_API_KEY"

JavaScript / Node.js


const response = await fetch(
'https://app.ignitevideo.cloud/api/analytics/plays?interval=day&contentType=vod',
{ 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/plays', [
'query' => ['interval' => 'day', 'contentType' => 'vod'],
'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
]);

Response


{
  "interval": "day" | "hour",
  "from": string,
  "to": string,
  "minimumWatchSeconds": number,
  "totals": {
    "views": number,
    "watchSeconds": number,
    "completions": number,
    "sessions": number
  },
  "series": [
    {
      "periodStart": string,
      "views": number,
      "watchSeconds": number,
      "completions": number,
      "sessions": number
    },
    [...]
  ]
}