Skip to main content
GET
Get analytics overview

Authorizations

X-Auth-Token
string
header
required

API key created in the dashboard or via POST /v1/api/api-keys. Keys are prefixed pn_ and do not expire until revoked.

Query Parameters

from
string<date>

Start date (YYYY-MM-DD). Defaults to the start of the current month.

to
string<date>

End date (YYYY-MM-DD). Defaults to today.

includeBandwidth
string

Any non-empty value adds bandwidth, storage and CDN metrics

Example:

"true"

source
string

Filter by traffic source

tags
string

Comma-separated tag IDs. Restricts results to videos carrying any of the tags.

country
string

ISO country code filter

Example:

"AU"

video
string

Restrict to a single video ID

Response

Analytics overview

totalPlays
integer
totalWatch
number

Total watch time in seconds

playsDateWise
object[]
categoryWise
object[]
countryWise
object[]
videoWise
object[]
totalBandwidthUsed
number

Bytes. Only with includeBandwidth.

storageUsed
number

MB. Only with includeBandwidth.

averageServerResponseTime
number

Only with includeBandwidth

bandwidthUsage
object

Bandwidth chart series. Only with includeBandwidth.

geoTrafficUsage
object

Traffic by region. Only with includeBandwidth.