GET /insights

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

Resource URL

Type URL and Format
GET https://public-api.wordpress.com/rest/v1/insights

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
name (string) Name of WordPress.com Application
id (id) Unique ID for a 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?

Example

cURL

curl 'https://public-api.wordpress.com/rest/v1/insights/?pretty=1'

PHP

<?php

$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
  'https://public-api.wordpress.com/rest/v1/insights/?pretty=1',
  false,
  $context
);
$response = json_decode( $response );

?>

Response Body

{
    "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": "2091",
            "percent": "-7.4%"
        },
        "rest_api_writes": {
            "number": "15",
            "percent": "-62.5%"
        },
        "rest_api_reads": {
            "number": "2076",
            "percent": "-6.3%"
        },
        "rest_api_errors": {
            "number": "161",
            "percent": "-4.2%"
        },
        "api_insights_connections": {
            "number": null,
            "percent": "%"
        },
        "api_insights_posts": {
            "number": "15",
            "percent": "-62.5%"
        },
        "api_insights_comments": {
            "number": null,
            "percent": "-100%"
        },
        "api_insights_likes": {
            "number": null,
            "percent": "-100%"
        }
    },
    "has_custom": false
}