GET /sites/$site/stats/streak

Get stats for Calendar Heatmap. Returns data with each post timestamp.

Resource Information

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

Method Parameters

Parameter Type Description
$site (int|string) Site 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.
startDate (string) start date for query
endDate (string) end date for query
max (int) maximum number of posts to return

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
400 invalid_input Invalid max value
400 invalid_input Invalid start date
400 invalid_input Start must predate end
400 invalid_input Invalid end date
403 unauthorized user cannot view stats

Example

cURL
1
2
3
curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/stats/streak'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?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/streak',
    false,
    $context
);
$response = json_decode( $response );
?>

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "streak": {
        "long": {
            "start": "",
            "end": "",
            "length": 1
        },
        "current": {
            "start": "",
            "end": "",
            "length": 0
        }
    },
    "data": []
}