View the details of a single video
Resource Information
Method
GET
URL
https://public-api.wordpress.com/rest/v1.1/sites/$site/stats/video/$post_id
Requires authentication?
Yes
Method Parameters
Parameter
Type
Description
$site
(int|string)
The site's id or domain
$post_id
(int)
The video's id
Query Parameters
Parameter
Type
Description
context
(string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope
(bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty
(bool)
false:
(default)
true:
Output pretty JSON
meta
(string)
Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields
(string)
Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback
(string)
An optional JSONP callback function.
statType
(string)
The metric to return: views|plays|impressions|watch_time|retention_rate|all. views and plays are equivalent. Default: 'views'.
period
(string)
The bucket granularity: day|week|month|year. Without date/start_date/num it selects the legacy trailing window instead. Default: 'day'.
num
(int)
Number of periods to include in the results. -1 returns the full series since the video was published.
date
(string)
The most recent day to include in results
start_date
(string)
The start date for the results; overrides num
offset
(int)
The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset
Response Parameters
Parameter
Type
Description
date
(string)
The most recent day for which stats are returned, when range parameters are used
period
(string)
The bucket granularity of the results, when range parameters are used
fields
(array)
An array containing the fields returned
data
(array)
An array containing the visits data
total
(object)
Totals over the requested window for the requested metric(s), keyed by metric name. retention_rate is play-weighted.
pages
(array)
An array of URLs of pages the video was played on
pages_detail
(array)
An array of pages the video was played on, each with url, post_id, and title (post_id and title are null for off-site pages)
post
(object)
Information about the video post object, including `poster` — the URL of the video's poster image, or null
Resource Errors
This endpoint does not return any errors.
Example
curl \
-H 'authorization: Bearer YOUR_API_TOKEN' \
'https://public-api.wordpress.com/rest/v1.1/sites/82974409/stats/video/34'
<?php
$options = array (
'http' =>
array (
'ignore_errors' => true,
'header' =>
array (
0 => 'authorization: Bearer YOUR_API_TOKEN',
),
),
);
$context = stream_context_create( $options );
$response = file_get_contents(
'https://public-api.wordpress.com/rest/v1.1/sites/82974409/stats/video/34',
false,
$context
);
$response = json_decode( $response );
?>