Developer Resources

Resource Information


Method	GET
URL	https://public-api.wordpress.com/rest/v1.1/sites/$site/stats/video-plays
Requires authentication?	Yes

Method Parameters

Parameter	Type	Description
$site	(int\|string)	The site's id or domain

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.
num	(int)	number of periods to include in the query Default: 1.
date	(string)	the most recent day to include in results
max	(int)	the maximum number of videos to include for each group of results Default: 10.
period	(string)	day: (default) The output will return results over the past [num] days week: The output will return results over the past [num] weeks month: The output will return results over the past [num] months year: The output will return results over the past [num] years
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
days	(array)	An array of days and the video plays that occurred on those days

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code	Error Identifier	Error Message
404	invalid_blog	This blog does not have Jetpack connected
404	invalid_blog	This blog does not have the Stats module enabled
403	unauthorized	User cannot access this private blog.
403	unauthorized	User cannot access this restricted blog
403	unauthorized	user cannot view stats

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/stats/video-plays'

<?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-plays',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "date": "2019-07-06",
    "period": "day",
    "days": {
        "2019-07-06": {
            "plays": [],
            "other_plays": 0,
            "total_plays": 0
        }
    }
}