publ Reference

vod_statistics_get

Reads video or playlist viewing statistics for a period, or the statistics overview (totals and the five most-viewed playlists and videos) in the Basic VOD app (pApp C00001). format csv also returns the page as the original CSV download.

Inputs

Field	Required here	Contract
`view`	Yes	one of: `vod-video-statistics`, `vod-playlist-statistics`, `vod-overview` (by `kind`)
`view.query`	No	When `view.kind` is `vod-video-statistics`: object; default `{"page":1,"limit":15}`
`view.query.start`	No	When `view.kind` is `vod-video-statistics`: string; pattern `^\d{4}-\d{2}-\d{2}$`; Period start (YYYY-MM-DD). Give start and end together (YYYY-MM-DD, from 2022-01-01); end is on or after start and less than 93 days after it (at most 93 calendar days), as the statistics date range allows. For a longer span, read consecutive periods.
`view.query.end`	No	When `view.kind` is `vod-video-statistics`: string; pattern `^\d{4}-\d{2}-\d{2}$`; Period end (YYYY-MM-DD). Give start and end together (YYYY-MM-DD, from 2022-01-01); end is on or after start and less than 93 days after it (at most 93 calendar days), as the statistics date range allows. For a longer span, read consecutive periods.
`view.query.page`	No	When `view.kind` is `vod-video-statistics`: integer; minimum 1; maximum 10000; default `1`
`view.query.limit`	No	When `view.kind` is `vod-video-statistics`: `15` or `30` or `50` or `100`; default `15`
`view.format`	No	When `view.kind` is `vod-video-statistics`: `csv`; csv: also return this page as the original CSV download (same page only).
`view.query`	No	When `view.kind` is `vod-playlist-statistics`: object; default `{"page":1,"limit":15}`
`view.query.start`	No	When `view.kind` is `vod-playlist-statistics`: string; pattern `^\d{4}-\d{2}-\d{2}$`; Period start (YYYY-MM-DD). Give start and end together (YYYY-MM-DD, from 2022-01-01); end is on or after start and less than 93 days after it (at most 93 calendar days), as the statistics date range allows. For a longer span, read consecutive periods.
`view.query.end`	No	When `view.kind` is `vod-playlist-statistics`: string; pattern `^\d{4}-\d{2}-\d{2}$`; Period end (YYYY-MM-DD). Give start and end together (YYYY-MM-DD, from 2022-01-01); end is on or after start and less than 93 days after it (at most 93 calendar days), as the statistics date range allows. For a longer span, read consecutive periods.
`view.query.page`	No	When `view.kind` is `vod-playlist-statistics`: integer; minimum 1; maximum 10000; default `1`
`view.query.limit`	No	When `view.kind` is `vod-playlist-statistics`: `15` or `30` or `50` or `100`; default `15`
`view.format`	No	When `view.kind` is `vod-playlist-statistics`: `csv`; csv: also return this page as the original CSV download (same page only).
`view.query`	No	When `view.kind` is `vod-overview`: object; default `{}`
`view.query.start`	No	When `view.kind` is `vod-overview`: string; pattern `^\d{4}-\d{2}-\d{2}$`; Period start (YYYY-MM-DD). Give start and end together (YYYY-MM-DD, from 2022-01-01); end is on or after start and less than 93 days after it (at most 93 calendar days), as the statistics date range allows. For a longer span, read consecutive periods.
`view.query.end`	No	When `view.kind` is `vod-overview`: string; pattern `^\d{4}-\d{2}-\d{2}$`; Period end (YYYY-MM-DD). Give start and end together (YYYY-MM-DD, from 2022-01-01); end is on or after start and less than 93 days after it (at most 93 calendar days), as the statistics date range allows. For a longer span, read consecutive periods.
`view.includePlayCounts`	No	When `view.kind` is `vod-overview`: boolean; Also read total play counts (an endpoint the console defines but shows on no screen).