GET /sites/$site/stats/opens/emails/summary

View the total number of email opens for each post.

Resource Information

   
Method GET
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/stats/opens/emails/summary
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.
quantity (int) Number of periods to include in the results Default: 10.
period (string)
hour:
(default) The output will return results over the past [num] hours
day:
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
alltime:
The output will return results from all time
date (string) The most recent day to include in results, accepts Y-m-d format

Response Parameters

Parameter Type Description
date (string) The most-recent day for which stats are returned
period (string) The period for which stats are returned
posts (array) An array of posts with the total views for each post

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 the Stats module enabled
404 invalid_blog This blog does not have Jetpack connected
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/SITE_ID/stats/opens/emails/summary?period=month&date=2022-01-01&quantity=2'
<?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/SITE_ID/stats/opens/emails/summary?period=month&date=2022-01-01&quantity=2',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "date": "2022-01-01",
    "period": "month",
    "posts": [
        {
            "id": 123,
            "href": "<POST_URL>",
            "date": "2021-11-07 21:00:00",
            "title": "Post Title 1",
            "type": "post",
            "opens": 31
        },
        {
            "id": 456,
            "href": "<POST_URL>",
            "date": "2021-11-08 20:00:00",
            "title": "Post Title 2",
            "type": "post",
            "opens": 18
        }
    ]
}