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

View multiple stats related to email opens by post.

Resource Information

   
Method GET
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/stats/opens/emails/$post_id
Requires authentication? No

Method Parameters

Parameter Type Description
$site (int|string) The site's id or domain.
$post_id (int) The post's id

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: 1.
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
date (string) The most recent day to include in results, accepts Y-m-d or Y-m-d\Th:00:00
stats_fields (string) A comma-separated list of the fields requested in the response Default: 'timeline,opens_rate,client,country,device'.

Response Parameters

Parameter Type Description
data (object) An object containing the opens rate, and the opens and sends counts.

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/post/POST_ID?num=2&period=day&date=2022-11-29&stat_fields=timeline,client,country,device'
<?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/post/POST_ID?num=2&period=day&date=2022-11-29&stat_fields=timeline,client,country,device',
	false,
	$context
);
$response = json_decode( $response );
?>