GET /insights/$slug

Get raw data for a particular graph.

Resource Information

   
Method GET
URL https://public-api.wordpress.com/rest/v1.1/insights/$slug
Requires authentication? Yes

Method Parameters

Parameter Type Description
$slug (string) Report slug (rest-api-calls, rest-api-writes, etc). If a slash is present, it must be urlencoded.

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.
unit (string) By default, weekly stats are provided in the data array. You can also pass daily, monthly, or cumulative to get totals for different time periods.
after (int) Return data only since the specified UNIX time.
before (int) Return data collected on or before the specified UNIX time.

Response Parameters

Parameter Type Description
points (int) The number of datapoints returned.
data (array) Numbers of actions by timestamp.
summaries (array) Summary for the current day/week/month/year/decade, including % change.
started_tracking (string) The date stats began collecting.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
404 not_found The stat does not exist
403 authorization_required This access token cannot view this insight information.
403 authorization_required An active access token with developer permissions for this app must be used to query insights information.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1/insights/rest-api-calls'
<?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/insights/rest-api-calls',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "points": 0,
    "data": [],
    "summaries": {
        "last_24_hours": null,
        "percent_change_since_previous_24_hours": null,
        "last_7_days": null,
        "percent_change_since_previous_7_days": null,
        "last_31_days": null,
        "percent_change_since_previous_31_days": null,
        "last_365_days": null,
        "percent_change_since_previous_365_days": null
    },
    "started_tracking": ""
}