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

View the total number of email opens and clicks for each post.

Resource Information


Method	GET
URL	https://public-api.wordpress.com/rest/v1.1/sites/$site/stats/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.
sort_field	(string)	opens: (default) Sort by the number of opens clicks: Sort by the number of clicks post_id: Sort by the post id post_date: Sort by the post date
sort_order	(string)	asc: (default) Sort in ascending order desc: Sort in descending order

Response Parameters

Parameter	Type	Description
posts	(array)	An array of posts with the total opens/clicks for each post

Resource Errors

This endpoint does not return any errors.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1.1/sites/SITE_ID/stats/emails/summary?quantity=20'

<?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/emails/summary?quantity=20',
	false,
	$context
);
$response = json_decode( $response );
?>