GET /sites/$site/wordads/stats

Get WordAds stats for a site

Resource Information

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

Method Parameters

Parameter Type Description
$site (int|string) Site 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.
unit (string) One of: day, week or month Default: 'day'.
quantity (int) number of units to return Default: 30.
date (string) limit the chart data to visits earlier than requested date

Response Parameters

Parameter Type Description
date (string) Date
unit (int) Stats unit
fields (array) Array of stats fields
data (array) Array of stats organized by date

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
401 Unauthorized You must be logged-in to view stats.
403 Forbidden You do not have the capability to view stats for this site.
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 'https://public-api.wordpress.com/rest/v1/sites/adtestsite.me/wordads/stats'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/sites/adtestsite.me/wordads/stats',
	false,
	$context
);
$response = json_decode( $response );
?>