GET /insights

Get a list of stats/metrics/insights that the current user has access to.

Resource Information

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

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.

Response Parameters

Parameter Type Description
ID (int) Unique ID for a WordPress.com Application
name (string) Name of WordPress.com Application
insights (array) List of metrics
today (array) A list of today's metrics
has_custom (bool) Does a report have custom (whitelisted) stats?

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
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.1/insights'
<?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/insights',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "ID": 594,
    "name": "Jetpack REST API Tester",
    "insights": [
        "rest-api-calls",
        "rest-api-writes",
        "rest-api-reads",
        "rest-api-errors",
        "api-insights-connections",
        "api-insights-posts",
        "api-insights-comments",
        "api-insights-likes"
    ],
    "today": {
        "rest_api_calls": {
            "number": null,
            "percent": "%"
        },
        "rest_api_writes": {
            "number": null,
            "percent": "%"
        },
        "rest_api_reads": {
            "number": null,
            "percent": "%"
        },
        "rest_api_errors": {
            "number": null,
            "percent": "%"
        },
        "api_insights_connections": {
            "number": null,
            "percent": "%"
        },
        "api_insights_posts": {
            "number": null,
            "percent": "%"
        },
        "api_insights_comments": {
            "number": null,
            "percent": "-100%"
        },
        "api_insights_likes": {
            "number": null,
            "percent": "%"
        }
    },
    "has_custom": false
}