Skip to content

GET/sites/$site/wordads/settings

Get detailed WordAds settings information about a site.

Resource Information

   
Method GET
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/wordads/settings
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.

Response Parameters

Parameter Type Description
ID (int) Site ID
name (string) Title of site
URL (string) Full URL to the site
settings (array) An array of options/settings for the blog. Only viewable by users with post editing rights to the site.

Resource Errors

This endpoint does not return any errors.

Example

curl 'https://public-api.wordpress.com/rest/v1/sites/adtestsite.me/wordads/settings'
<?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/settings',
	false,
	$context
);
$response = json_decode( $response );
?>