View a site's top posts and pages by views
Resource Information
Method
GET
URL
https://public-api.wordpress.com/rest/v1.1/sites/$site/stats/top-posts
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.
num
(int)
Number of periods to include in the results Default: 1.
period
(string)
day:
(default) 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
start_date
(string)
the start date to calculate days included in results
max
(int)
The maximum number of results to return Default: 10.
offset
(int)
The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset
summarize
(bool)
Return summary data instead of detailed period data
skip_archives
(bool)
Skip home/archives pages from the results
migrate_archive_homepage
(bool)
Migrate archive homepage views to update the Home page / Archive display
Response Parameters
Parameter
Type
Description
date
(string)
The most-recent day for which stats are returned
days
(array)
An array of days and the post views that occurred on those days (omitted when summarize=true)
summary
(array)
Summary of post views that occured over the specified period (omitted when summarize=false)
period
(string)
The period for which stats are returned
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/top-posts'
<?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/top-posts',
false,
$context
);
$response = json_decode( $response );
?>
