GET/sites/$site/stats/followers

View a site's followers

Resource Information


Method	GET
URL	https://public-api.wordpress.com/rest/v1.1/sites/$site/stats/followers
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.
type	(string)	One of: 'wpcom' or 'email'. Default: 'wpcom'.
page	(int)	The page of results to return. Default: 1.
max	(int)	The number of results to return per page. Defaults to 20. Maximum 100. Default: 20.
search	(string)	Returns followers with matching email addresses. Only works in combination with type="email".
filter_admin	(bool)	Filter admin from being subscribers count if the value is true. Default: false.

Response Parameters

Parameter	Type	Description
page	(int)	The current page of results returned
pages	(int)	The total number of pages of results available
total	(int)	The total number of followers
total_email	(int)	The total number of email-only followers
total_wpcom	(int)	The total number of WordPress.com followers
subscribers	(array)	An array containing the subscribers
is_owner_subscribing	(bool)	Has the site owner been subscribing to the blog

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/82974409/stats/followers'

<?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/82974409/stats/followers',
	false,
	$context
);
$response = json_decode( $response );
?>