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) |
|
http_envelope | (bool) |
|
pretty | (bool) |
|
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". |
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 |
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 Jetpack connected |
404 | invalid_blog | This blog does not have the Stats module enabled |
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/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 ); ?>
Response
{ "page": 1, "pages": 1, "total": 1, "total_email": 0, "total_wpcom": 1, "subscribers": [ { "avatar": "https:\/\/0.gravatar.com\/avatar\/6525b4196105c94c2d43da2579ec445d?s=64&d=https%3A%2F%2F0.gravatar.com%2Favatar%2Fad516503a11cd5ca435acc9bb6523536%3Fs%3D64&r=G", "label": "hazeleyedgirl1593", "login": "hazeleyedgirl1593", "ID": 130976211, "url": "http:\/\/hazeleyedgirl1593.wordpress.com", "follow_data": { "params": { "stat-source": "stats_comments", "follow-text": "Follow", "following-text": "Following", "following-hover-text": "Unfollow", "blog_domain": "hazeleyedgirl1593.wordpress.com", "blog_url": "http:\/\/hazeleyedgirl1593.wordpress.com", "blog_id": 138786518, "site_id": 138786518, "blog_title": "hazeleyedgirl1593", "is_following": false }, "type": "follow" }, "date_subscribed": "2019-08-10T21:25:23+00:00" }, { "avatar": "https:\/\/1.gravatar.com\/avatar\/a2afb7b6c0e23e5d363d8612fb1bd5ad?s=64&d=https%3A%2F%2F1.gravatar.com%2Favatar%2Fad516503a11cd5ca435acc9bb6523536%3Fs%3D64&r=G", "label": "apiexamples", "login": "apiexamples", "ID": 78972699, "url": "http:\/\/apiexamples.wordpress.com", "follow_data": null, "date_subscribed": "2015-01-15T06:56:11+00:00" } ] }