{ "opencollection": "1.0.0", "info": { "name": "WordPress.com REST API v1.1", "version": "v1.1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "batch", "type": "folder" }, "items": [ { "info": { "name": "Run several GET endpoints and return them as an array.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/batch/", "params": [ { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "urls", "value": "", "type": "query", "description": "Array of endpoints to call" } ] }, "docs": "Run several GET endpoints and return them as an array." } ] }, { "info": { "name": "freshly-pressed", "type": "folder" }, "items": [ { "info": { "name": "Get a list of Freshly Pressed posts.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/freshly-pressed/", "params": [ { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of posts to return. Default: 10. Limit: 40. Default: 10." }, { "name": "after", "value": "", "type": "query", "description": "Return posts picked on or after the specified datetime." }, { "name": "before", "value": "", "type": "query", "description": "Return posts picked on or before the specified datetime." }, { "name": "content_width", "value": "", "type": "query", "description": "When in context=display, images/embeds in post content will be set to the desired maximum width. Default: 480." }, { "name": "thumb_width", "value": "", "type": "query", "description": "Desired width of thumbnail images, in pixels. Default: 252." }, { "name": "thumb_height", "value": "", "type": "query", "description": "Desired height of thumbnail images, in pixels. Default: 160." }, { "name": "format", "value": "", "type": "query", "description": "Output format. Accepts \"json\" or \"rss\". Default: json. Default: 'json'." } ] }, "docs": "Get a list of Freshly Pressed posts." } ] }, { "info": { "name": "insights", "type": "folder" }, "items": [ { "info": { "name": "Get a list of stats/metrics/insights that the current user has access to.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/insights", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of stats/metrics/insights that the current user has access to." }, { "info": { "name": "Get raw data for a particular graph.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/insights/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "Report slug (rest-api-calls, rest-api-writes, etc). If a slash is present, it must be urlencoded." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "unit", "value": "", "type": "query", "description": "By default, weekly stats are provided in the data array. You can also pass daily, monthly, or cumulative to get totals for different time periods." }, { "name": "after", "value": "", "type": "query", "description": "Return data only since the specified UNIX time." }, { "name": "before", "value": "", "type": "query", "description": "Return data collected on or before the specified UNIX time." } ] }, "docs": "Get raw data for a particular graph." } ] }, { "info": { "name": "site", "type": "folder" }, "items": [ { "info": { "name": "Get a list of your Jetpack-enabled blogs.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/jetpack-blogs/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of your Jetpack-enabled blogs." }, { "info": { "name": "Get Jetpack settings.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/jetpack-blogs/:blog_id/", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "The blog id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get Jetpack settings." }, { "info": { "name": "Update Jetpack settings.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/jetpack-blogs/:blog_id/", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "The blog id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Jetpack settings." }, { "info": { "name": "Disconnect a Jetpack-enabled blog from a WordPress.com user.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/jetpack-blogs/:blog_id/mine/delete", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "The blog id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Disconnect a Jetpack-enabled blog from a WordPress.com user." }, { "info": { "name": "Test connection of a Jetpack blog.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/jetpack-blogs/:blog_id/test-connection", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "The blog id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "is_stale_connection_healthy", "value": "", "type": "query", "description": "The current state (possibly stale) of connection health of the Jetpack site." } ] }, "docs": "Test connection of a Jetpack blog." }, { "info": { "name": "Migrate followers from a WordPress.com blog to a Jetpack-enabled blog.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/jetpack-blogs/:dest_blog_id/source/:source_blog_id/migrate/", "params": [ { "name": "dest_blog_id", "value": "", "type": "path", "description": "The Jetpack-enabled blog where followers are moving." }, { "name": "source_blog_id", "value": "", "type": "path", "description": "The WordPress.com blog where followers currently reside." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Migrate followers from a WordPress.com blog to a Jetpack-enabled blog." } ] }, { "info": { "name": "manual-payments", "type": "folder" }, "items": [ { "info": { "name": "Pay a manual payment", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/manual_payment", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "uid", "value": "", "type": "query", "description": "Unique ID of payment" } ] }, "docs": "Pay a manual payment" }, { "info": { "name": "Return a payment object containing a collection of items that need to be paid for together.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/manual_payment/%s", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "uid", "value": "", "type": "query", "description": "Unique ID of payment" } ] }, "docs": "Return a payment object containing a collection of items that need to be paid for together." } ] }, { "info": { "name": "marketing", "type": "folder" }, "items": [ { "info": { "name": "Submit a marketing survey.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/marketing/survey", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submit a marketing survey." } ] }, { "info": { "name": "users", "type": "folder" }, "items": [ { "info": { "name": "Get metadata about the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me", "params": [ { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "abtests", "value": "", "type": "query", "description": "Comma separated names of A/B tests the user may have an assigned variation for" } ] }, "docs": "Get metadata about the current user." }, { "info": { "name": "Get list of current user's billing history and upcoming charges.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/billing-history", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get list of current user's billing history and upcoming charges." }, { "info": { "name": "Get current user's connected applications.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/connected-applications/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get current user's connected applications." }, { "info": { "name": "Get one of current user's connected applications.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/connected-applications/:ID", "params": [ { "name": "ID", "value": "", "type": "path", "description": "The ID of the connected application's connection." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get one of current user's connected applications." }, { "info": { "name": "Delete one of current user's connected application access tokens.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/connected-applications/:ID/delete", "params": [ { "name": "ID", "value": "", "type": "path", "description": "The ID of the connected application's connection." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete one of current user's connected application access tokens." }, { "info": { "name": "Get a list of the current user's likes.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/likes/", "params": [ { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of likes to return. Limit: 100. Default: 20." }, { "name": "offset", "value": "", "type": "query", "description": "The index to start counting from." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of likes. Takes precedence over the offset parameter. Limit: 10." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) (default) Return likes newest to oldest.; ASC: Return likes oldest to newest." }, { "name": "after", "value": "", "type": "query", "description": "Return likes dated on or after the specified datetime." }, { "name": "before", "value": "", "type": "query", "description": "Return likes dated on or before the specified datetime." } ] }, "docs": "Get a list of the current user's likes." }, { "info": { "name": "Get the current user's settings.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/preferences/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the current user's settings." }, { "info": { "name": "Update the current user's preferences.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/preferences/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the current user's preferences." }, { "info": { "name": "Get the current user's settings.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/settings/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the current user's settings." }, { "info": { "name": "Update the current user's settings.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/settings/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the current user's settings." }, { "info": { "name": "Verify strength of a user's new password.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/settings/password/validate", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify strength of a user's new password." }, { "info": { "name": "Get current user's profile links.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/settings/profile-links/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get current user's profile links." }, { "info": { "name": "Add a link to current user's profile.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/settings/profile-links/new", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a link to current user's profile." }, { "info": { "name": "Delete a link from current user's profile.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/settings/profile-links/:slug/delete", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The URL of the profile link." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete a link from current user's profile." }, { "info": { "name": "Get information about current user's two factor configuration.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/two-step", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get information about current user's two factor configuration." }, { "info": { "name": "Sends a two-step code via SMS to the current user.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/two-step/sms/new", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Sends a two-step code via SMS to the current user." }, { "info": { "name": "Invite one or more users to your site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/invites/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite one or more users to your site." }, { "info": { "name": "List the users of a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/users", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "Limit the total number of authors returned. Default: 20." }, { "name": "offset", "value": "", "type": "query", "description": "The first n authors to be skipped in the returned array." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) Return authors in descending order.; ASC: Return authors in ascending order." }, { "name": "order_by", "value": "", "type": "query", "description": "ID: (default) Order by ID (default).; login: Order by username.; nicename: Order by nicename.; email: Order by author email address.; url: Order by author URL.; registered: Order by registered date.; display_name: Order by display name.; post_count: Order by number of posts published." }, { "name": "authors_only", "value": "", "type": "query", "description": "Set to true to fetch authors only" }, { "name": "include_viewers", "value": "", "type": "query", "description": "Set to true to include viewers for Simple sites. When you pass in this parameter, order, order_by and search_columns are ignored. Currently, `search` is limited to the first page of results." }, { "name": "type", "value": "", "type": "query", "description": "Specify the post type to query authors for. Only works when combined with the `authors_only` flag. Defaults to 'post'. Post types besides post and page need to be whitelisted using the rest_api_allowed_post_types filter." }, { "name": "search", "value": "", "type": "query", "description": "Find matching users." }, { "name": "search_columns", "value": "", "type": "query", "description": "Specify which columns to check for matching users. Can be any of 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename', and 'display_name'. Only works when combined with `search` parameter." }, { "name": "role", "value": "", "type": "query", "description": "Specify a specific user role to fetch." }, { "name": "capability", "value": "", "type": "query", "description": "Specify a specific capability to fetch. You can specify multiple by comma-separating them, in which case the user needs to match all capabilities provided." } ] }, "docs": "List the users of a site." }, { "info": { "name": "Get details of a user of a site by login.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/users/login::user_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID or domain." }, { "name": "user_id", "value": "", "type": "path", "description": "The user's login." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get details of a user of a site by login." }, { "info": { "name": "Deletes or removes a user of a site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/users/:user_ID/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID or domain." }, { "name": "user_ID", "value": "", "type": "path", "description": "The user's ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes or removes a user of a site." }, { "info": { "name": "Update details of a user of a site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/users/:user_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID or domain." }, { "name": "user_id", "value": "", "type": "path", "description": "The user's ID." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update details of a user of a site." }, { "info": { "name": "Get a list of possible users to suggest for @mentions.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/users/suggest", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "site_id", "value": "", "type": "query", "description": "The site ID to look for matching users on." }, { "name": "site", "value": "", "type": "query", "description": "The domain to look for matching users on. (Overrides site_id.)" }, { "name": "filter", "value": "", "type": "query", "description": "Optional. A string to filter possible users against." }, { "name": "image_size", "value": "", "type": "query", "description": "Optional. The size of the image to return in pixels. (Default 96, minimum 1, maximum 2048.)" }, { "name": "client", "value": "", "type": "query", "description": "Optional. A string identifying the consumer of the data." } ] }, "docs": "Get a list of possible users to suggest for @mentions." }, { "info": { "name": "Get metadata about a user.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/users/:user", "params": [ { "name": "user", "value": "", "type": "path", "description": "The user ID or username of the user." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get metadata about a user." } ] }, { "info": { "name": "sharing", "type": "folder" }, "items": [ { "info": { "name": "Get a list of all the keyring connections associated with the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/keyring-connections/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "site", "value": "", "type": "query", "description": "Optional. Only return connections for the given site." }, { "name": "force_external_users_refetch", "value": "", "type": "query", "description": "True to force refetch external users, default false" }, { "name": "force_connection_test", "value": "", "type": "query", "description": "True to force testing the connection and not use the cache, default false" } ] }, "docs": "Get a list of all the keyring connections associated with the current user." }, { "info": { "name": "Get a single Keyring connection that the current user has setup.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/keyring-connections/:keyring_connection_ID", "params": [ { "name": "keyring_connection_ID", "value": "", "type": "path", "description": "The connection ID to take action on." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a single Keyring connection that the current user has setup." }, { "info": { "name": "Delete the Keyring connection (and associated token) with the provided ID. Also deletes all associated publicize connect", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/keyring-connections/:keyring_connection_ID/delete", "params": [ { "name": "keyring_connection_ID", "value": "", "type": "path", "description": "The connection ID to take action on." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete the Keyring connection (and associated token) with the provided ID. Also deletes all associated publicize connections." }, { "info": { "name": "Get a list of publicize connections that the current user has set up.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/publicize-connections/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "service", "value": "", "type": "query", "description": "Optional. Only return connections for the given services." }, { "name": "keyring_connection_ID", "value": "", "type": "query", "description": "Optional. Only return connections for the given keyring connection ID." }, { "name": "site", "value": "", "type": "query", "description": "Optional. Only return connections for the given site that the user can publicize to. Includes global connections owned by other users on the site." } ] }, "docs": "Get a list of publicize connections that the current user has set up." }, { "info": { "name": "Get a single publicize connection that the current user has set up.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/publicize-connections/:publicize_connection_ID", "params": [ { "name": "publicize_connection_ID", "value": "", "type": "path", "description": "The publicize connection ID to fetch." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a single publicize connection that the current user has set up." }, { "info": { "name": "Update a single publicize connection belonging to the current user.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/publicize-connections/:publicize_connection_ID", "params": [ { "name": "publicize_connection_ID", "value": "", "type": "path", "description": "The publicize connection ID to take action on." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a single publicize connection belonging to the current user." }, { "info": { "name": "Delete the specified publicize connection.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/me/publicize-connections/:publicize_connection_ID/delete", "params": [ { "name": "publicize_connection_ID", "value": "", "type": "path", "description": "The connection ID to take action on." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete the specified publicize connection." }, { "info": { "name": "Get a list of third-party services that WordPress.com or Jetpack sites can integrate with via keyring.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/meta/external-services/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "type", "value": "", "type": "query", "description": "Optional. Only return services for the given type. Currently the only supported types are `publicize` or `other`." } ] }, "docs": "Get a list of third-party services that WordPress.com or Jetpack sites can integrate with via keyring." }, { "info": { "name": "Get information about a single external service that WordPress.com or Jetpack sites can integrate with via keyring.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/meta/external-services/:service", "params": [ { "name": "service", "value": "", "type": "path", "description": "Which service you want information about (facebook, twitter, etc). See /meta/external-services/ for list of supported services." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get information about a single external service that WordPress.com or Jetpack sites can integrate with via keyring." }, { "info": { "name": "Get a list of external services for which sharing buttons are supported.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/meta/sharing-buttons", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of external services for which sharing buttons are supported." }, { "info": { "name": "Get a list of publicize connections that are associated with the specified site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/publicize-connections/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "service", "value": "", "type": "query", "description": "Optional. Only return connections for the given services." }, { "name": "user_id", "value": "", "type": "query", "description": "Optional. Only return connections associated to the given user ID." }, { "name": "keyring_connection_ID", "value": "", "type": "query", "description": "Optional. Only return connections for the given Keyring connection ID." } ] }, "docs": "Get a list of publicize connections that are associated with the specified site." }, { "info": { "name": "Create a new publicize connection that is associated with the specified site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/publicize-connections/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new publicize connection that is associated with the specified site." }, { "info": { "name": "Get a single publicize connection that is associated with the specified site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/publicize-connections/:publicize_connection_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "publicize_connection_ID", "value": "", "type": "path", "description": "The publicize connection ID to fetch." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a single publicize connection that is associated with the specified site." }, { "info": { "name": "Update a single publicize connection belonging to the specified site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/publicize-connections/:publicize_connection_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID to take action on." }, { "name": "publicize_connection_ID", "value": "", "type": "path", "description": "The publicize connection ID to take action on." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a single publicize connection belonging to the specified site." }, { "info": { "name": "Delete the specified publicize connection.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/publicize-connections/:publicize_connection_ID/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "publicize_connection_ID", "value": "", "type": "path", "description": "The connection ID to take action on." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete the specified publicize connection." }, { "info": { "name": "Edit all sharing buttons for a site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/sharing-buttons", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit all sharing buttons for a site." }, { "info": { "name": "Get a list of a site's sharing buttons.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/sharing-buttons/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "enabled_only", "value": "", "type": "query", "description": "If true, only enabled sharing buttons are included in the response" }, { "name": "visibility", "value": "", "type": "query", "description": "The type of enabled sharing buttons to filter by, either \"visible\" or \"hidden\"" } ] }, "docs": "Get a list of a site's sharing buttons." } ] }, { "info": { "name": "me", "type": "folder" }, "items": [ { "info": { "name": "List all email mailboxes the current user has access to across all manageable sites.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/mailboxes", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "include_all_managed_domains", "value": "", "type": "query", "description": "Include domains on managed sites that the current user does not own. Defaults to false, which returns only domains the user pays for." } ] }, "docs": "List all email mailboxes the current user has access to across all manageable sites." } ] }, { "info": { "name": "posts", "type": "folder" }, "items": [ { "info": { "name": "Get a list of posts across all the user's sites.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/posts", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "author", "value": "", "type": "query", "description": "The ID of the author or empty for `all authors`" }, { "name": "number", "value": "", "type": "query", "description": "The number of posts to return. Limit: 20. Default: 20." }, { "name": "offset", "value": "", "type": "query", "description": "The index to start counting from. Limit: 199." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of posts. Takes precedence over the offset parameter. Limit: 10." }, { "name": "page_handle", "value": "", "type": "query", "description": "A page handle, returned from a previous API call as a meta.next_page property. This is the most efficient way to fetch the next page of results." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) Return posts in descending order. For dates, that means newest to oldest.; ASC: Return posts in ascending order. For dates, that means oldest to newest." }, { "name": "order_by", "value": "", "type": "query", "description": "date: (default) Order by the created time of each post (search queries will sort by relevance).; modified: Order by the modified time (gmt) of each post. (search queries will sort by relevance)" }, { "name": "after", "value": "", "type": "query", "description": "Return posts dated after the specified datetime." }, { "name": "before", "value": "", "type": "query", "description": "Return posts dated before the specified datetime." }, { "name": "modified_after", "value": "", "type": "query", "description": "Return posts modified after the specified datetime." }, { "name": "modified_before", "value": "", "type": "query", "description": "Return posts modified before the specified datetime." }, { "name": "type", "value": "", "type": "query", "description": "post: (default) Return post objects; page: Return page objects" }, { "name": "status", "value": "", "type": "query", "description": "Comma-separated list of statuses for which to query, including any of: \"publish\", \"private\", \"draft\", \"pending\", \"future\", and \"trash\", or simply \"any\". Defaults to \"publish\"" }, { "name": "search", "value": "", "type": "query", "description": "Search query checked against `title`, `content`, `category.name`, `tag.name`, and `author`, and will return results sorted by relevance. Limit: 250 characters" }, { "name": "lang", "value": "", "type": "query", "description": "The search language, uses user interface language by default" }, { "name": "sites", "value": "", "type": "query", "description": "Optional comma-separated list of specific site IDs to further limit results" }, { "name": "site_visibility", "value": "", "type": "query", "description": "all: (default) Return posts from all sites user is a member of, both visible and hidden; visible: Only return posts from sites set to visible for the user; hidden: Only return posts from sites set to hidden for the user" } ] }, "docs": "Get a list of posts across all the user's sites." }, { "info": { "name": "Get a list of pages to be displayed as options in a select-a-page-dropdown.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/dropdown-pages/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of pages to be displayed as options in a select-a-page-dropdown." }, { "info": { "name": "Get a list of matching posts.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of posts to return. Limit: 100. Default: 20." }, { "name": "offset", "value": "", "type": "query", "description": "0-indexed offset." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of posts. Takes precedence over the offset parameter." }, { "name": "page_handle", "value": "", "type": "query", "description": "A page handle, returned from a previous API call as a meta.next_page property. This is the most efficient way to fetch the next page of results." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) Return posts in descending order. For dates, that means newest to oldest.; ASC: Return posts in ascending order. For dates, that means oldest to newest." }, { "name": "order_by", "value": "", "type": "query", "description": "date: (default) Order by the created time of each post.; modified: Order by the modified time of each post.; title: Order lexicographically by the posts' titles.; comment_count: Order by the number of comments for each post.; ID: Order by post ID." }, { "name": "after", "value": "", "type": "query", "description": "Return posts dated after the specified datetime." }, { "name": "before", "value": "", "type": "query", "description": "Return posts dated before the specified datetime." }, { "name": "modified_after", "value": "", "type": "query", "description": "Return posts modified after the specified datetime." }, { "name": "modified_before", "value": "", "type": "query", "description": "Return posts modified before the specified datetime." }, { "name": "tag", "value": "", "type": "query", "description": "Specify the tag name or slug." }, { "name": "category", "value": "", "type": "query", "description": "Specify the category name or slug." }, { "name": "term", "value": "", "type": "query", "description": "Specify comma-separated term slugs to search within, indexed by taxonomy slug." }, { "name": "type", "value": "", "type": "query", "description": "Specify the post type. Defaults to 'post', use 'any' to query for both posts and pages. Post types besides post and page need to be whitelisted using the rest_api_allowed_post_types filter." }, { "name": "parent_id", "value": "", "type": "query", "description": "Returns only posts which are children of the specified post. Applies only to hierarchical post types." }, { "name": "include", "value": "", "type": "query", "description": "Includes the specified post ID(s) in the response" }, { "name": "exclude", "value": "", "type": "query", "description": "Excludes the specified post ID(s) from the response" }, { "name": "exclude_tree", "value": "", "type": "query", "description": "Excludes the specified post and all of its descendants from the response. Applies only to hierarchical post types." }, { "name": "status", "value": "", "type": "query", "description": "Comma-separated list of statuses for which to query, including any of: \"publish\", \"private\", \"draft\", \"pending\", \"future\", and \"trash\", or simply \"any\". Defaults to \"publish\"" }, { "name": "sticky", "value": "", "type": "query", "description": "include: (default) Sticky posts are not excluded from the list.; exclude: Sticky posts are excluded from the list.; require: Only include sticky posts" }, { "name": "author", "value": "", "type": "query", "description": "Author's user ID" }, { "name": "search", "value": "", "type": "query", "description": "Search query" }, { "name": "meta_key", "value": "", "type": "query", "description": "Metadata key that the post should contain" }, { "name": "meta_value", "value": "", "type": "query", "description": "Metadata value that the post should contain. Will only be applied if a `meta_key` is also given" } ] }, "docs": "Get a list of matching posts." }, { "info": { "name": "Delete multiple posts. Note: If the trash is enabled, this request will send non-trashed posts to the trash. Trashed pos", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete multiple posts. Note: If the trash is enabled, this request will send non-trashed posts to the trash. Trashed posts will be permanently deleted." }, { "info": { "name": "Create a post.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a post." }, { "info": { "name": "Restore multiple posts.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/restore", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore multiple posts." }, { "info": { "name": "Get a single post (by slug).", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/slug::post_slug", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_slug", "value": "", "type": "path", "description": "The post slug (a.k.a. sanitized name)" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a single post (by slug)." }, { "info": { "name": "Get a single post (by ID).", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a single post (by ID)." }, { "info": { "name": "Edit a post.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a post." }, { "info": { "name": "Delete a post. Note: If the trash is enabled, this request will send the post to the trash. A second request will perman", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete a post. Note: If the trash is enabled, this request will send the post to the trash. A second request will permanently delete the post." }, { "info": { "name": "Get a list of the likes for a post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/likes/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "chronological", "value": "", "type": "query", "description": "get likers on chronological order" } ] }, "docs": "Get a list of the likes for a post." }, { "info": { "name": "Get the current user's like status for a post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/likes/mine/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the current user's like status for a post." }, { "info": { "name": "Unlike a post.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/likes/mine/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Unlike a post." }, { "info": { "name": "Like a post.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/likes/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Like a post." }, { "info": { "name": "Get reblog status for a post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/reblogs/mine", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get reblog status for a post." }, { "info": { "name": "Reblog a post.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/reblogs/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reblog a post." }, { "info": { "name": "Restore a post or page from the trash to its previous status.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/restore", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Restore a post or page from the trash to its previous status." }, { "info": { "name": "Search within a site for related posts.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post/related", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post", "value": "", "type": "path", "description": "The post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: total,max_score" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search within a site for related posts." }, { "info": { "name": "Get a list of the specified post's subscribers.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post/subscribers/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post", "value": "", "type": "path", "description": "Post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of the specified post's subscribers." }, { "info": { "name": "Get subscription status of the specified post for the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post/subscribers/mine", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post", "value": "", "type": "path", "description": "Post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get subscription status of the specified post for the current user." }, { "info": { "name": "Unsubscribe the current user from the specified post.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post/subscribers/mine/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post", "value": "", "type": "path", "description": "Post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Unsubscribe the current user from the specified post." }, { "info": { "name": "Subscribe current user to be notified of the specified post's comments.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post/subscribers/mine/update", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post", "value": "", "type": "path", "description": "Post ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Subscribe current user to be notified of the specified post's comments." }, { "info": { "name": "Subscribe current user to be notified of the specified post's comments.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post/subscribers/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post", "value": "", "type": "path", "description": "Post ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Subscribe current user to be notified of the specified post's comments." }, { "info": { "name": "Get a list of published posts authored by a specified user across their public sites, ordered by date in descending orde", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/users/:user_id/posts", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "The ID of the user whose posts to return" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of posts to return. Must be between 1 and 20. Default: 20." }, { "name": "page_handle", "value": "", "type": "query", "description": "A page handle containing value, blog, and post parameters, returned from a previous request's meta.next_page property." } ] }, "docs": "Get a list of published posts authored by a specified user across their public sites, ordered by date in descending order." } ] }, { "info": { "name": "sites", "type": "folder" }, "items": [ { "info": { "name": "Get a list of the current user's sites.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/sites", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "site_visibility", "value": "", "type": "query", "description": "all: (default) Return all sites user is a member of, both visible and hidden.; visible: Only return sites set to visible for the user.; hidden: Only return sites set to hidden for the user." }, { "name": "options", "value": "", "type": "query", "description": "Optional. Returns specified options only. Comma-separated list. Example: options=login_url,timezone" }, { "name": "include_domain_only", "value": "", "type": "query", "description": "Optional. Whether to include domain-only sites" }, { "name": "include_redirect", "value": "", "type": "query", "description": "Optional. Whether to include redirect sites. Default: true." }, { "name": "include_a8c_owned", "value": "", "type": "query", "description": "Optional. Whether to include A8C owned sites. Default: true." }, { "name": "site_activity", "value": "", "type": "query", "description": "all: (default) Return all sites both active or inactive.; active: Only return active sites.; inactive: Only return inactive sites." } ] }, "docs": "Get a list of the current user's sites." }, { "info": { "name": "Not in use", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/sites/compact", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "options", "value": "", "type": "query", "description": "Optional. Returns specified options only. Comma-separated list. Example: options=login_url,timezone" }, { "name": "site_visibility", "value": "", "type": "query", "description": "visible: (default) Only return sites set to visible for the user." }, { "name": "site_activity", "value": "", "type": "query", "description": "active: (default) Only return active sites." }, { "name": "include_domain_only", "value": "", "type": "query" }, { "name": "include_redirect", "value": "", "type": "query" }, { "name": "include_a8c_owned", "value": "", "type": "query" } ] }, "docs": "Not in use" }, { "info": { "name": "Get a list of the current user's sites features", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/sites/features", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of the current user's sites features" }, { "info": { "name": "Get a list of the current user's sites plugins", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/me/sites/plugins", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of the current user's sites plugins" }, { "info": { "name": "Get information about a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "options", "value": "", "type": "query", "description": "Optional. Returns specified options only. Comma-separated list. Example: options=login_url,timezone" } ] }, "docs": "Get information about a site." }, { "info": { "name": "Returns the current status of Automated Transfer for a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/automated-transfers/status", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Returns the current status of Automated Transfer for a site." }, { "info": { "name": "Get a list of embeds available on a site. Note: The current user must have publishing access.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/embeds", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of embeds available on a site. Note: The current user must have publishing access." }, { "info": { "name": "Get a rendered embed for a site. Note: The current user must have publishing access.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/embeds/render", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "embed_url", "value": "", "type": "query", "description": "The query-string encoded embed URL to render. Required. Only accepts one at a time." } ] }, "docs": "Get a rendered embed for a site. Note: The current user must have publishing access." }, { "info": { "name": "Get the custom header options for a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/headers/mine", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the custom header options for a site." }, { "info": { "name": "Set the custom header options for a site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/headers/mine", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the custom header options for a site." }, { "info": { "name": "Get the custom header options for a site with a particular theme.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/headers/:theme_slug", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "theme_slug", "value": "", "type": "path", "description": "The slug of the theme." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the custom header options for a site with a particular theme." }, { "info": { "name": "Get a list of page templates supported by a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/page-templates", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of page templates supported by a site." }, { "info": { "name": "Get number of posts in the post type groups by post status", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/post-counts/:post_type", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_type", "value": "", "type": "path", "description": "Post Type" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "author", "value": "", "type": "query", "description": "author ID" } ] }, "docs": "Get number of posts in the post type groups by post status" }, { "info": { "name": "Get a list of post types available for a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/post-types", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "api_queryable", "value": "", "type": "query", "description": "If true, only queryable post types are returned" } ] }, "docs": "Get a list of post types available for a site." }, { "info": { "name": "Search within a site using an Elasticsearch Query API.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/search", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search within a site using an Elasticsearch Query API." }, { "info": { "name": "Get a list of shortcodes available on a site. Note: The current user must have publishing access.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/shortcodes", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of shortcodes available on a site. Note: The current user must have publishing access." }, { "info": { "name": "Get a rendered shortcode for a site. Note: The current user must have publishing access.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/shortcodes/render", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "shortcode", "value": "", "type": "query", "description": "The query-string encoded shortcode string to render. Required. Only accepts one at a time." } ] }, "docs": "Get a rendered shortcode for a site. Note: The current user must have publishing access." }, { "info": { "name": "Retrieve the active and inactive widgets for a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/widgets", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Retrieve the active and inactive widgets for a site." }, { "info": { "name": "Activate a widget on a site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/widgets/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activate a widget on a site." }, { "info": { "name": "Retrieve a widget on a site by its ID.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/widgets/widget::id", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "id", "value": "", "type": "path", "description": "Widget ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Retrieve a widget on a site by its ID." }, { "info": { "name": "Update a widget on a site by its ID.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/widgets/widget::id", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "id", "value": "", "type": "path", "description": "Widget ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a widget on a site by its ID." }, { "info": { "name": "Deactivate a widget on a site by its ID. Will delete if already deactivated.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/widgets/widget::id/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "id", "value": "", "type": "path", "description": "Widget ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Deactivate a widget on a site by its ID. Will delete if already deactivated." }, { "info": { "name": "Request streamlined approval to join the WordAds program.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/wordads/approve", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Request streamlined approval to join the WordAds program." }, { "info": { "name": "Get detailed WordAds earnings information about a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/wordads/earnings", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get detailed WordAds earnings information about a site." }, { "info": { "name": "Get detailed WordAds settings information about a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/wordads/settings", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get detailed WordAds settings information about a site." }, { "info": { "name": "Update WordAds settings for a site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/wordads/settings", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update WordAds settings for a site." }, { "info": { "name": "Get WordAds stats for a site", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/wordads/stats", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "unit", "value": "", "type": "query", "description": "One of: day, week or month Default: 'day'." }, { "name": "quantity", "value": "", "type": "query", "description": "number of units to return Default: 30." }, { "name": "date", "value": "", "type": "query", "description": "limit the chart data to visits earlier than requested date" } ] }, "docs": "Get WordAds stats for a site" }, { "info": { "name": "Get WordAds TOS information about a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/wordads/tos", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get WordAds TOS information about a site." }, { "info": { "name": "Update WordAds TOS setting for a site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/wordads/tos", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update WordAds TOS setting for a site." } ] }, { "info": { "name": "notifications", "type": "folder" }, "items": [ { "info": { "name": "Mark a set of notifications as read.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/notifications/read", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mark a set of notifications as read." }, { "info": { "name": "Set the timestamp of the most recently seen notification.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/notifications/seen", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the timestamp of the most recently seen notification." } ] }, { "info": { "name": "read", "type": "folder" }, "items": [ { "info": { "name": "Returns the email settings", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/email-settings/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Returns the email settings" }, { "info": { "name": "Returns the email settings", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/read/email-settings/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the email settings" }, { "info": { "name": "Get the ID and subscribe URL of one or more matching feeds by domain or URL.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/feed/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "url", "value": "", "type": "query", "description": "The domain or URL of the site you would like to retrieve the feed(s) ID for. It MUST be URL-encoded." }, { "name": "q", "value": "", "type": "query", "description": "Query text" }, { "name": "offset", "value": "", "type": "query", "description": "offset to page results to" }, { "name": "number", "value": "", "type": "query", "description": "number of results to return" }, { "name": "exclude_followed", "value": "", "type": "query", "description": "Exclude already followed sites in search results Default: true." }, { "name": "sort", "value": "", "type": "query", "description": "relevance or last_updated" }, { "name": "page_handle", "value": "", "type": "query", "description": "A handle for getting the next page of results when sorting by last_updated" }, { "name": "algorithm", "value": "", "type": "query", "description": "Specify a particular algorithm to use to choose posts (optional)" } ] }, "docs": "Get the ID and subscribe URL of one or more matching feeds by domain or URL." }, { "info": { "name": "Get details about a feed.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/feed/:feed_url_or_id", "params": [ { "name": "feed_url_or_id", "value": "", "type": "path", "description": "The URL for the feed you would like more details on, or the id of the Feed. If a URL is passed, it MUST be URL-encoded." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get details about a feed." }, { "info": { "name": "Get a list of posts from the blogs a user follows.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/following/", "params": [ { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of posts to return. Limit: 40. Default: 10." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of posts." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) Return posts in descending order. For dates, that means newest to oldest.; ASC: Return posts in ascending order. For dates, that means oldest to newest." }, { "name": "after", "value": "", "type": "query", "description": "Return posts dated after the specified datetime." }, { "name": "before", "value": "", "type": "query", "description": "Return posts dated before the specified datetime." }, { "name": "feed_id", "value": "", "type": "query", "description": "The feed_id to fetch the posts from." } ] }, "docs": "Get a list of posts from the blogs a user follows." }, { "info": { "name": "Get a list of the feeds the user is following.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/following/mine", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of the feeds the user is following." }, { "info": { "name": "Unfollow the specified blog.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/read/following/mine/delete", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "sub_id", "value": "", "type": "query", "description": "The subscription ID to remove" }, { "name": "url", "value": "", "type": "query", "description": "The URL of the blog you want to unfollow, if the subscription ID is not known" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unfollow the specified blog." }, { "info": { "name": "Follow the specified blog.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/read/following/mine/new", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "url", "value": "", "type": "query", "description": "The URL of the blog to follow." }, { "name": "source", "value": "", "type": "query", "description": "The source of the follow" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Follow the specified blog." }, { "info": { "name": "Get a list of posts from the blogs a user likes.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/liked/", "params": [ { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of posts to return. Limit: 40. Default: 10." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of posts." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) Return posts in descending order. For dates, that means newest to oldest.; ASC: Return posts in ascending order. For dates, that means oldest to newest." }, { "name": "after", "value": "", "type": "query", "description": "Return posts dated after the specified datetime." }, { "name": "before", "value": "", "type": "query", "description": "Return posts dated before the specified datetime." } ] }, "docs": "Get a list of posts from the blogs a user likes." }, { "info": { "name": "Get an array of Reader lists by user slug.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/lists/:user_slug", "params": [ { "name": "user_slug", "value": "", "type": "path", "description": "The slug of the user whose lists to retrieve." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get an array of Reader lists by user slug." }, { "info": { "name": "Get default reader menu.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/menu/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get default reader menu." }, { "info": { "name": "Get a list of blog recommendations for the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/recommendations/mine/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "exclude", "value": "", "type": "query", "description": "Array of blog_ids to exclude." }, { "name": "number", "value": "", "type": "query", "description": "Number of blogs to return (optional, default is 4)." }, { "name": "lang", "value": "", "type": "query", "description": "Language code for localized reason strings." }, { "name": "source", "value": "", "type": "query", "description": "The source this request comes from: [\"mobile\", \"reader_sidebar\", \"reader_inline\", \"recap_2013\"]" } ] }, "docs": "Get a list of blog recommendations for the current user." }, { "info": { "name": "Get a single post (by ID).", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/sites/:site/posts/:post_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a single post (by ID)." }, { "info": { "name": "Returns the number of blog, comment and pending subscriptions.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/subscriptions-count/", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Returns the number of blog, comment and pending subscriptions." }, { "info": { "name": "Get a list of tags subscribed to by the user.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/tags", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of tags subscribed to by the user." }, { "info": { "name": "Get a filtered list of top tags, grouped by letter.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/tags/alphabetic", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "lang", "value": "", "type": "query", "description": "The language code for the tags" } ] }, "docs": "Get a filtered list of top tags, grouped by letter." }, { "info": { "name": "Get details about a specified tag.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/tags/:tag", "params": [ { "name": "tag", "value": "", "type": "path", "description": "The tag name" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get details about a specified tag." }, { "info": { "name": "Get the subscribed status of the user to a given tag.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/tags/:tag/mine", "params": [ { "name": "tag", "value": "", "type": "path", "description": "The tag name" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the subscribed status of the user to a given tag." }, { "info": { "name": "Unsubscribe from a tag.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/read/tags/:tag/mine/delete", "params": [ { "name": "tag", "value": "", "type": "path", "description": "The name of the tag to unsubscribe from." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Unsubscribe from a tag." }, { "info": { "name": "Subscribe to a new tag.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/read/tags/:tag/mine/new", "params": [ { "name": "tag", "value": "", "type": "path", "description": "The name of the tag to subscribe to." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Subscribe to a new tag." }, { "info": { "name": "Get a list of posts from a tag.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/tags/:tag/posts", "params": [ { "name": "tag", "value": "", "type": "path", "description": "The tag name" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of posts to return. Limit: 40. Default: 10." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of posts." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) Return posts in descending order. For dates, that means newest to oldest.; ASC: Return posts in ascending order. For dates, that means oldest to newest." }, { "name": "after", "value": "", "type": "query", "description": "Return posts dated after the specified datetime." }, { "name": "before", "value": "", "type": "query", "description": "Return posts dated before the specified datetime." }, { "name": "lang", "value": "", "type": "query", "description": "Return posts in the specified language." } ] }, "docs": "Get a list of posts from a tag." }, { "info": { "name": "Get a list of trending tags.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/read/trending/tags", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "lang", "value": "", "type": "query", "description": "The language code for the tags" }, { "name": "count", "value": "", "type": "query", "description": "The number of topics to fetch Default: 20." } ] }, "docs": "Get a list of trending tags." } ] }, { "info": { "name": "taxonomy", "type": "folder" }, "items": [ { "info": { "name": "Get a list of a site's categories.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/categories", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of categories to return. Limit: 1000. Default: 100." }, { "name": "offset", "value": "", "type": "query", "description": "0-indexed offset." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of categories. Takes precedence over the offset parameter." }, { "name": "search", "value": "", "type": "query", "description": "Limit response to include only categories whose names or slugs match the provided search query." }, { "name": "order", "value": "", "type": "query", "description": "ASC: (default) Return categories in ascending order.; DESC: Return categories in descending order." }, { "name": "order_by", "value": "", "type": "query", "description": "name: (default) Order by the name of each category.; count: Order by the number of posts in each category." } ] }, "docs": "Get a list of a site's categories." }, { "info": { "name": "Create a new category.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/categories/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new category." }, { "info": { "name": "Get information about a single category.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/categories/slug::category", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "category", "value": "", "type": "path", "description": "The category slug" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get information about a single category." }, { "info": { "name": "Edit a category.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/categories/slug::category", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "category", "value": "", "type": "path", "description": "The category slug" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a category." }, { "info": { "name": "Delete a category.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/categories/slug::category/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "category", "value": "", "type": "path", "description": "The category slug" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete a category." }, { "info": { "name": "Get a list of taxonomies associated with a post type.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/post-types/:post_type/taxonomies", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_type", "value": "", "type": "path", "description": "Post type" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of taxonomies associated with a post type." }, { "info": { "name": "Get a list of a site's tags.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/tags", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of tags to return. Limit: 1000. Default: 100." }, { "name": "offset", "value": "", "type": "query", "description": "0-indexed offset." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of tags. Takes precedence over the offset parameter." }, { "name": "search", "value": "", "type": "query", "description": "Limit response to include only tags whose names or slugs match the provided search query." }, { "name": "order", "value": "", "type": "query", "description": "ASC: (default) Return tags in ascending order.; DESC: Return tags in descending order." }, { "name": "order_by", "value": "", "type": "query", "description": "name: (default) Order by the name of each tag.; count: Order by the number of posts in each tag." } ] }, "docs": "Get a list of a site's tags." }, { "info": { "name": "Create a new tag.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/tags/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new tag." }, { "info": { "name": "Get information about a single tag.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/tags/slug::tag", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "tag", "value": "", "type": "path", "description": "The tag slug" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get information about a single tag." }, { "info": { "name": "Edit a tag.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/tags/slug::tag", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "tag", "value": "", "type": "path", "description": "The tag slug" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a tag." }, { "info": { "name": "Delete a tag.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/tags/slug::tag/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "tag", "value": "", "type": "path", "description": "The tag slug" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete a tag." }, { "info": { "name": "Get a list of a site's terms by taxonomy.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/taxonomies/:taxonomy/terms", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "taxonomy", "value": "", "type": "path", "description": "Taxonomy" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of terms to return. Limit: 1000. Default: 100." }, { "name": "offset", "value": "", "type": "query", "description": "0-indexed offset." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of terms. Takes precedence over the offset parameter." }, { "name": "search", "value": "", "type": "query", "description": "Limit response to include only terms whose names or slugs match the provided search query." }, { "name": "order", "value": "", "type": "query", "description": "ASC: (default) Return terms in ascending order.; DESC: Return terms in descending order." }, { "name": "order_by", "value": "", "type": "query", "description": "name: (default) Order by the name of each tag.; count: Order by the number of posts in each tag." } ] }, "docs": "Get a list of a site's terms by taxonomy." }, { "info": { "name": "Create a new term.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/taxonomies/:taxonomy/terms/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "taxonomy", "value": "", "type": "path", "description": "Taxonomy" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new term." }, { "info": { "name": "Get information about a single term.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/taxonomies/:taxonomy/terms/slug::slug", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "taxonomy", "value": "", "type": "path", "description": "Taxonomy" }, { "name": "slug", "value": "", "type": "path", "description": "Term slug" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get information about a single term." }, { "info": { "name": "Edit a term.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/taxonomies/:taxonomy/terms/slug::slug", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "taxonomy", "value": "", "type": "path", "description": "Taxonomy" }, { "name": "slug", "value": "", "type": "path", "description": "The term slug" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a term." }, { "info": { "name": "Delete a term.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/taxonomies/:taxonomy/terms/slug::slug/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "taxonomy", "value": "", "type": "path", "description": "Taxonomy" }, { "name": "slug", "value": "", "type": "path", "description": "The term slug" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete a term." } ] }, { "info": { "name": "comments", "type": "folder" }, "items": [ { "info": { "name": "Get comment counts for each available status", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comment-counts", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "post_id", "value": "", "type": "query", "description": "post ID for filtering the comment counts by post" } ] }, "docs": "Get comment counts for each available status" }, { "info": { "name": "Get the audit history for given comment", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comment-history/:comment_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "comment_ID", "value": "", "type": "path", "description": "The comment ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the audit history for given comment" }, { "info": { "name": "Get a list of recent comments.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of comments to return. Limit: 100. When using hierarchical=1, number refers to the number of top-level comments returned. Default: 20." }, { "name": "offset", "value": "", "type": "query", "description": "0-indexed offset. Not available if using hierarchical=1." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of comments. Takes precedence over the offset parameter. When using hierarchical=1, pagination is a bit different. See the note on the number parameter." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) Return comments in descending order from newest to oldest.; ASC: Return comments in ascending order from oldest to newest." }, { "name": "hierarchical", "value": "", "type": "query", "description": "false: (default); true: (BETA) Order the comment list hierarchically." }, { "name": "after", "value": "", "type": "query", "description": "Return comments dated on or after the specified datetime. Not available if using hierarchical=1." }, { "name": "before", "value": "", "type": "query", "description": "Return comments dated on or before the specified datetime. Not available if using hierarchical=1." }, { "name": "type", "value": "", "type": "query", "description": "any: (default) Return all comments regardless of type.; comment: Return only regular comments.; trackback: Return only trackbacks.; pingback: Return only pingbacks.; pings: Return both trackbacks and pingbacks." }, { "name": "status", "value": "", "type": "query", "description": "approved: (default) Return only approved comments.; unapproved: Return only comments in the moderation queue.; spam: Return only comments marked as spam.; trash: Return only comments in the trash.; all: Return comments of all statuses." }, { "name": "author_wpcom_data", "value": "", "type": "query", "description": "false: (default) Do not add wpcom_id and wpcom_login fields to comment author responses (default); true: Add wpcom_id and wpcom_login fields to comment author responses" } ] }, "docs": "Get a list of recent comments." }, { "info": { "name": "Get a single comment.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments/:comment_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "comment_ID", "value": "", "type": "path", "description": "The comment ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a single comment." }, { "info": { "name": "Edit a comment.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments/:comment_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "comment_ID", "value": "", "type": "path", "description": "The comment ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a comment." }, { "info": { "name": "Delete a comment.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments/:comment_ID/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "comment_ID", "value": "", "type": "path", "description": "The comment ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete a comment." }, { "info": { "name": "Get the likes for a comment.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments/:comment_ID/likes/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "comment_ID", "value": "", "type": "path", "description": "The comment ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the likes for a comment." }, { "info": { "name": "Get your like status for a comment.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments/:comment_ID/likes/mine/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "comment_ID", "value": "", "type": "path", "description": "The comment ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get your like status for a comment." }, { "info": { "name": "Remove your like from a comment.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments/:comment_ID/likes/mine/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "comment_ID", "value": "", "type": "path", "description": "The comment ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Remove your like from a comment." }, { "info": { "name": "Like a comment.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments/:comment_ID/likes/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "comment_ID", "value": "", "type": "path", "description": "The comment ID" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Like a comment." }, { "info": { "name": "Create a comment as a reply to another comment.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments/:comment_ID/replies/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "comment_ID", "value": "", "type": "path", "description": "The comment ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a comment as a reply to another comment." }, { "info": { "name": "Get a list of recent comments on a post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/replies/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of comments to return. Limit: 100. When using hierarchical=1, number refers to the number of top-level comments returned. Default: 20." }, { "name": "offset", "value": "", "type": "query", "description": "0-indexed offset. Not available if using hierarchical=1." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of comments. Takes precedence over the offset parameter. When using hierarchical=1, pagination is a bit different. See the note on the number parameter." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) Return comments in descending order from newest to oldest.; ASC: Return comments in ascending order from oldest to newest." }, { "name": "hierarchical", "value": "", "type": "query", "description": "false: (default); true: (BETA) Order the comment list hierarchically." }, { "name": "after", "value": "", "type": "query", "description": "Return comments dated on or after the specified datetime. Not available if using hierarchical=1." }, { "name": "before", "value": "", "type": "query", "description": "Return comments dated on or before the specified datetime. Not available if using hierarchical=1." }, { "name": "type", "value": "", "type": "query", "description": "any: (default) Return all comments regardless of type.; comment: Return only regular comments.; trackback: Return only trackbacks.; pingback: Return only pingbacks.; pings: Return both trackbacks and pingbacks." }, { "name": "status", "value": "", "type": "query", "description": "approved: (default) Return only approved comments.; unapproved: Return only comments in the moderation queue.; spam: Return only comments marked as spam.; trash: Return only comments in the trash.; all: Return comments of all statuses." }, { "name": "author_wpcom_data", "value": "", "type": "query", "description": "false: (default) Do not add wpcom_id and wpcom_login fields to comment author responses (default); true: Add wpcom_id and wpcom_login fields to comment author responses" } ] }, "docs": "Get a list of recent comments on a post." }, { "info": { "name": "Create a comment on a post.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/posts/:post_ID/replies/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a comment on a post." } ] }, { "info": { "name": "comments-tree", "type": "folder" }, "items": [ { "info": { "name": "Get a comments tree for site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/comments-tree", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "status", "value": "", "type": "query", "description": "Filter returned comments based on this value (allowed values: all, approved, pending, trash, spam)." } ] }, "docs": "Get a comments tree for site." } ] }, { "info": { "name": "people", "type": "folder" }, "items": [ { "info": { "name": "View a site's followers", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/followers", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "type", "value": "", "type": "query", "description": "One of: 'wpcom', 'email' or 'all'. Default: 'wpcom'." }, { "name": "page", "value": "", "type": "query", "description": "The page of results to return. Default: 1." }, { "name": "max", "value": "", "type": "query", "description": "The number of results to return per page. Defaults to 20. Maximum 100. Default: 20." }, { "name": "search", "value": "", "type": "query", "description": "Returns followers with matching email addresses. Only works in combination with type=\"email\"." } ] }, "docs": "View a site's followers" }, { "info": { "name": "View a site's follower or subscriber", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/followers/:subscriber_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "subscriber_id", "value": "", "type": "path", "description": "The ID of the wpcom follower." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "type", "value": "", "type": "query", "description": "One of: 'wpcom' or 'email'. Default: 'wpcom'." } ] }, "docs": "View a site's follower or subscriber" } ] }, { "info": { "name": "follow", "type": "folder" }, "items": [ { "info": { "name": "List a site's followers in reverse chronological order.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/follows/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "page", "value": "", "type": "query", "description": "page number Default: 1." }, { "name": "number", "value": "", "type": "query", "description": "number of followers to return Default: 20." } ] }, "docs": "List a site's followers in reverse chronological order." }, { "info": { "name": "Get blog following status for the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/follows/mine", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get blog following status for the current user." }, { "info": { "name": "Unfollow a blog.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/follows/mine/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Unfollow a blog." }, { "info": { "name": "Follow a blog.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/follows/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "source", "value": "", "type": "query", "description": "The source of the follow" } ] }, "docs": "Follow a blog." } ] }, { "info": { "name": "import", "type": "folder" }, "items": [ { "info": { "name": "Get information about any current imports for this site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/imports/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get information about any current imports for this site." }, { "info": { "name": "Prepare an import for this site. Note that only one import can be in progress at any time.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/imports/library/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Prepare an import for this site. Note that only one import can be in progress at any time." }, { "info": { "name": "Prepare an import for this site. Note that only one import can be in progress at any time.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/imports/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Prepare an import for this site. Note that only one import can be in progress at any time." }, { "info": { "name": "Get information about the state of an import.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/imports/:import_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "import_id", "value": "", "type": "path", "description": "The import ID." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get information about the state of an import." }, { "info": { "name": "Update the import for a site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/imports/:import_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "import_id", "value": "", "type": "path", "description": "The import ID." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the import for a site." } ] }, { "info": { "name": "media", "type": "folder" }, "items": [ { "info": { "name": "Get a list of items in the media library.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/media/", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "number", "value": "", "type": "query", "description": "The number of media items to return. Limit: 100. Default: 20." }, { "name": "offset", "value": "", "type": "query", "description": "0-indexed offset." }, { "name": "page", "value": "", "type": "query", "description": "Return the Nth 1-indexed page of posts. Takes precedence over the offset parameter." }, { "name": "page_handle", "value": "", "type": "query", "description": "A page handle, returned from a previous API call as a meta.next_page property. This is the most efficient way to fetch the next page of results." }, { "name": "order", "value": "", "type": "query", "description": "DESC: (default) Return files in descending order. For dates, that means newest to oldest.; ASC: Return files in ascending order. For dates, that means oldest to newest." }, { "name": "order_by", "value": "", "type": "query", "description": "date: (default) Order by the uploaded time of each file.; title: Order lexicographically by file titles.; ID: Order by media ID." }, { "name": "search", "value": "", "type": "query", "description": "Search query." }, { "name": "post_ID", "value": "", "type": "query", "description": "Default is showing all items. The post where the media item is attached. 0 shows unattached media items." }, { "name": "mime_type", "value": "", "type": "query", "description": "Default is empty. Filter by mime type (e.g., 'image/jpeg', 'application/pdf'). Partial searches also work (e.g. passing 'image' will search for all image files)." }, { "name": "after", "value": "", "type": "query", "description": "Return media items uploaded after the specified datetime." }, { "name": "before", "value": "", "type": "query", "description": "Return media items uploaded before the specified datetime." } ] }, "docs": "Get a list of items in the media library." }, { "info": { "name": "Upload a new piece of media.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/media/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload a new piece of media." }, { "info": { "name": "Get a single media item (by ID).", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/media/:media_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "media_ID", "value": "", "type": "path", "description": "The ID of the media item" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a single media item (by ID)." }, { "info": { "name": "Edit basic information about a media item.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/media/:media_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "media_ID", "value": "", "type": "path", "description": "The ID of the media item" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit basic information about a media item." }, { "info": { "name": "Delete a piece of media. Note: Media is deleted and not trashed.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/media/:media_ID/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "media_ID", "value": "", "type": "path", "description": "The media ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete a piece of media. Note: Media is deleted and not trashed." }, { "info": { "name": "Edit a media item.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/media/:media_ID/edit", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "media_ID", "value": "", "type": "path", "description": "The ID of the media item" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a media item." } ] }, { "info": { "name": "menus", "type": "folder" }, "items": [ { "info": { "name": "Get a list of all navigation menus.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/menus", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a list of all navigation menus." }, { "info": { "name": "Create a new navigation menu.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/menus/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new navigation menu." }, { "info": { "name": "Get a single navigation menu.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/menus/:menu_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "menu_id", "value": "", "type": "path", "description": "Menu ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a single navigation menu." }, { "info": { "name": "Update a navigation menu.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/menus/:menu_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "menu_id", "value": "", "type": "path", "description": "Menu ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a navigation menu." }, { "info": { "name": "Delete a navigation menu", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/menus/:menu_id/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "menu_id", "value": "", "type": "path", "description": "Menu ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Delete a navigation menu" } ] }, { "info": { "name": "protect", "type": "folder" }, "items": [ { "info": { "name": "A site confirms that a user can bypass jetpack to try to login and login", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/protect/recovery/confirm", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A site confirms that a user can bypass jetpack to try to login and login" }, { "info": { "name": "A user request an email containing a recovery url that they can use to bypass a Protect blockage", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/protect/recovery/request", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A user request an email containing a recovery url that they can use to bypass a Protect blockage" }, { "info": { "name": "Validates a url emailed to a user containing a recovery toke that they can use to bypass a Protect blockage", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/protect/recovery/validate/:user_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "user_id", "value": "", "type": "path", "description": "The user id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "token", "value": "", "type": "query", "description": "The recovery token." }, { "name": "action", "value": "", "type": "query", "description": "What action to redirect the to." } ] }, "docs": "Validates a url emailed to a user containing a recovery toke that they can use to bypass a Protect blockage" } ] }, { "info": { "name": "stats", "type": "folder" }, "items": [ { "info": { "name": "Get a site's stats", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a site's stats" }, { "info": { "name": "View a site's archives", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/archives", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "max", "value": "", "type": "query", "description": "The maximum number of results to return Default: 10." }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" }, { "name": "skip_archives", "value": "", "type": "query", "description": "Skip home/archives pages from the results" }, { "name": "migrate_archive_homepage", "value": "", "type": "query", "description": "Migrate archive homepage views to update the Home page / Archive display" } ] }, "docs": "View a site's archives" }, { "info": { "name": "View a site's outbound clicks", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/clicks", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "max", "value": "", "type": "query", "description": "The maximum number of results to return Default: 10." }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" } ] }, "docs": "View a site's outbound clicks" }, { "info": { "name": "View the total number of email clicks for each post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/clicks/emails/summary", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "quantity", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 10." }, { "name": "period", "value": "", "type": "query", "description": "hour: (default) The output will return results over the past [num] hours; day: 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; alltime: The output will return results from all time" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results, accepts Y-m-d format" } ] }, "docs": "View the total number of email clicks for each post." }, { "info": { "name": "View chart stats related to email clicks by period.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/clicks/emails/:post_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "quantity", "value": "", "type": "query", "description": "Number of periods to include in the results" }, { "name": "period", "value": "", "type": "query", "description": "hour: (default) The output will return results over the next [quantity] hours; day: The output will return results over the next [quantity] days" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results, accepts Y-m-d or Y-m-d\\Th:00:00" } ] }, "docs": "View chart stats related to email clicks by period." }, { "info": { "name": "View email clicks by client.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/clicks/emails/:post_id/client", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email clicks by client." }, { "info": { "name": "View email clicks by country.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/clicks/emails/:post_id/country", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email clicks by country." }, { "info": { "name": "View email clicks by device.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/clicks/emails/:post_id/device", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email clicks by device." }, { "info": { "name": "View email clicks by link.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/clicks/emails/:post_id/link", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email clicks by link." }, { "info": { "name": "View email clicks rate by post. Returns mock data.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/clicks/emails/:post_id/rate", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email clicks rate by post. Returns mock data." }, { "info": { "name": "View email clicks by user content link.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/clicks/emails/:post_id/user-content-link", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email clicks by user content link." }, { "info": { "name": "View a site's comment followers", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/comment-followers", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "page", "value": "", "type": "query", "description": "The page of results to return. Default: 1." }, { "name": "max", "value": "", "type": "query", "description": "The number of results to return per page. Numbers larger than 20 will default to 20. Default: 20." } ] }, "docs": "View a site's comment followers" }, { "info": { "name": "View a site's top comment authors and most-commented posts", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/comments", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View a site's top comment authors and most-commented posts" }, { "info": { "name": "View a site's views by country", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/country-views", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "max", "value": "", "type": "query", "description": "the maximum number of countries to include in the results Default: 10." }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" } ] }, "docs": "View a site's views by country" }, { "info": { "name": "Fetch site's Device properties statistics.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/devices/:device_property_name", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "device_property_name", "value": "", "type": "path", "description": "screensize: (default) Stats for screen sizes; platform: Stats for operating systems; browser: Stats for browsers" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "max", "value": "", "type": "query", "description": "The maximum number of results to return Default: 10." }, { "name": "date", "value": "", "type": "query", "description": "the most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "days", "value": "", "type": "query", "description": "number of days to include in the query Default: 1." } ] }, "docs": "Fetch site's Device properties statistics." }, { "info": { "name": "View the total number of email opens and clicks for each post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/emails/summary", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "quantity", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 10." }, { "name": "sort_field", "value": "", "type": "query", "description": "opens: (default) Sort by the number of opens; clicks: Sort by the number of clicks; post_id: Sort by the post id; post_date: Sort by the post date" }, { "name": "sort_order", "value": "", "type": "query", "description": "asc: (default) Sort in ascending order; desc: Sort in descending order" } ] }, "docs": "View the total number of email opens and clicks for each post." }, { "info": { "name": "View a site's file downloads", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/file-downloads", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "number of periods to include in the query Default: 1." }, { "name": "date", "value": "", "type": "query", "description": "the most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "max", "value": "", "type": "query", "description": "the maximum number of files to include for each group of results Default: 10." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" } ] }, "docs": "View a site's file downloads" }, { "info": { "name": "View a site's followers", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/followers", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "type", "value": "", "type": "query", "description": "One of: 'wpcom' or 'email'. Default: 'wpcom'." }, { "name": "page", "value": "", "type": "query", "description": "The page of results to return. Default: 1." }, { "name": "max", "value": "", "type": "query", "description": "The number of results to return per page. Defaults to 20. Maximum 100. Default: 20." }, { "name": "search", "value": "", "type": "query", "description": "Returns followers with matching email addresses. Only works in combination with type=\"email\"." }, { "name": "filter_admin", "value": "", "type": "query", "description": "Filter admin from being subscribers count if the value is true. Default: false." } ] }, "docs": "View a site's followers" }, { "info": { "name": "View highlight metrics from the last seven days.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/highlights", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View highlight metrics from the last seven days." }, { "info": { "name": "View a site's views by country, region and city", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/location-views/:geo_mode", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "geo_mode", "value": "", "type": "path", "description": "country: (default) Stats per country; region: Stats per region; city: Stats per city" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "max", "value": "", "type": "query", "description": "the maximum number of countries to include in the results Default: 10." }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" }, { "name": "filter_by_country", "value": "", "type": "query", "description": "The ISO-3166-1 country code to filter results with" } ] }, "docs": "View a site's views by country, region and city" }, { "info": { "name": "View the total number of email opens for each post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/opens/emails/summary", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "quantity", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 10." }, { "name": "period", "value": "", "type": "query", "description": "hour: (default) The output will return results over the past [num] hours; day: 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; alltime: The output will return results from all time" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results, accepts Y-m-d format" } ] }, "docs": "View the total number of email opens for each post." }, { "info": { "name": "View multiple stats related to email opens by post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/opens/emails/:post_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "quantity", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "hour: (default) The output will return results over the past [num] hours; day: 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" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results, accepts Y-m-d or Y-m-d\\Th:00:00" }, { "name": "stats_fields", "value": "", "type": "query", "description": "A comma-separated list of the fields requested in the response Default: 'timeline,opens_rate,client,country,device'." } ] }, "docs": "View multiple stats related to email opens by post." }, { "info": { "name": "View email opens stats by client.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/opens/emails/:post_id/client", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email opens stats by client." }, { "info": { "name": "View email opens stats by country.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/opens/emails/:post_id/country", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email opens stats by country." }, { "info": { "name": "View email opens stats by device.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/opens/emails/:post_id/device", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email opens stats by device." }, { "info": { "name": "View email opens rate by post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/opens/emails/:post_id/rate", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View email opens rate by post." }, { "info": { "name": "View a post's views", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/post/:post_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "post_id", "value": "", "type": "path", "description": "The post's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View a post's views" }, { "info": { "name": "View a site's publicize follower counts", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/publicize", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "View a site's publicize follower counts" }, { "info": { "name": "View a site's referrers", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/referrers", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "max", "value": "", "type": "query", "description": "The maximum number of results to return Default: 10." }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" } ] }, "docs": "View a site's referrers" }, { "info": { "name": "List referrers marked as spam", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/referrers/spam", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "List referrers marked as spam" }, { "info": { "name": "Unreport a referrer as spam", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/referrers/spam/delete", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "domain", "value": "", "type": "query", "description": "The domain of the site being unreported as spam" } ] }, "docs": "Unreport a referrer as spam" }, { "info": { "name": "Report a referrer as spam", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/referrers/spam/new", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "domain", "value": "", "type": "query", "description": "The domain of the site being reported as spam" } ] }, "docs": "Report a referrer as spam" }, { "info": { "name": "View search terms used to find the site", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/search-terms", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "max", "value": "", "type": "query", "description": "The maximum number of results to return Default: 10." }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" } ] }, "docs": "View search terms used to find the site" }, { "info": { "name": "Get stats for Calendar Heatmap. Returns data with each post timestamp.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/streak", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "startDate", "value": "", "type": "query", "description": "start date for query" }, { "name": "endDate", "value": "", "type": "query", "description": "end date for query" }, { "name": "max", "value": "", "type": "query", "description": "maximum number of posts to return" } ] }, "docs": "Get stats for Calendar Heatmap. Returns data with each post timestamp." }, { "info": { "name": "View a site's summarized views, visitors, likes and comments", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/summary", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "day: (default) The output will return results over the past [num] days, the last day being 'date'; week: The output will return results over the past [num] weeks, the last week being the one including 'date'; month: The output will return results over the past [num] months, the last month being the one including 'date'; year: The output will return results over the past [num] years, the last year being the one including 'date'" }, { "name": "date", "value": "", "type": "query", "description": "The date that determines the most recent period for which results are returned" }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" } ] }, "docs": "View a site's summarized views, visitors, likes and comments" }, { "info": { "name": "View a site's views by tags and categories", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/tags", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "max", "value": "", "type": "query", "description": "the maximum number of tags to include in result Default: 10." } ] }, "docs": "View a site's views by tags and categories" }, { "info": { "name": "View a site's top authors", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/top-authors", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "max", "value": "", "type": "query", "description": "the maximum number of authors to include in results Default: 10." }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" } ] }, "docs": "View a site's top authors" }, { "info": { "name": "View a site's top posts and pages by views", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/top-posts", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results Default: 1." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "max", "value": "", "type": "query", "description": "The maximum number of results to return Default: 10." }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" }, { "name": "skip_archives", "value": "", "type": "query", "description": "Skip home/archives pages from the results" }, { "name": "migrate_archive_homepage", "value": "", "type": "query", "description": "Migrate archive homepage views to update the Home page / Archive display" } ] }, "docs": "View a site's top posts and pages by views" }, { "info": { "name": "Fetch site's UTM param statistics.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/utm/:utm_param_name", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "utm_param_name", "value": "", "type": "path", "description": "utm_id: (default) Stats for utm_id parameter; utm_source: Stats for utm_source parameter; utm_medium: Stats for utm_medium parameter; utm_campaign: Stats for utm_campaign parameter; utm_term: Stats for utm_term parameter; utm_content: Stats for utm_content parameter; utm_source_platform: Stats for utm_source_platform parameter; utm_creative_format: Stats for utm_creative_format parameter; utm_marketing_tactic: Stats for utm_marketing_tactic parameter; utm_source,utm_medium: Stats for combinations of two UTM parameters: utm_source, utm_medium; utm_campaign,utm_source,utm_medium: Stats for combinations of three UTM parameters: utm_campaign, utm_source, utm_medium" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "max", "value": "", "type": "query", "description": "The maximum number of results to return Default: 10." }, { "name": "date", "value": "", "type": "query", "description": "the most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "days", "value": "", "type": "query", "description": "number of days to include in the query Default: 1." }, { "name": "post_id", "value": "", "type": "query", "description": "post's id, set this if you want to fetch stats for a specific post only" }, { "name": "query_top_posts", "value": "", "type": "query", "description": "return top posts for utm combinations Default: false." } ] }, "docs": "Fetch site's UTM param statistics." }, { "info": { "name": "Fetch top posts for a given UTM parameter value.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/utm/:utm_param_name/top_posts", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "utm_param_name", "value": "", "type": "path", "description": "utm_id: (default) Stats for utm_id parameter; utm_source: Stats for utm_source parameter; utm_medium: Stats for utm_medium parameter; utm_campaign: Stats for utm_campaign parameter; utm_term: Stats for utm_term parameter; utm_content: Stats for utm_content parameter; utm_source_platform: Stats for utm_source_platform parameter; utm_creative_format: Stats for utm_creative_format parameter; utm_marketing_tactic: Stats for utm_marketing_tactic parameter; utm_source,utm_medium: Stats for combinations of two UTM parameters: utm_source, utm_medium; utm_campaign,utm_source,utm_medium: Stats for combinations of three UTM parameters: utm_campaign, utm_source, utm_medium" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "utm_param_values", "value": "", "type": "query", "description": "Required. UTM parameter values for which to fetch breakdown by posts. When $utm_param_name contains comma this should be the string containing a json-encoded array." }, { "name": "max", "value": "", "type": "query", "description": "The maximum number of results to return Default: 10." }, { "name": "date", "value": "", "type": "query", "description": "the most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "the start date to calculate days included in results" }, { "name": "days", "value": "", "type": "query", "description": "number of days to include in the query Default: 1." } ] }, "docs": "Fetch top posts for a given UTM parameter value." }, { "info": { "name": "View a site's video plays", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/video-plays", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "num", "value": "", "type": "query", "description": "number of periods to include in the query Default: 1." }, { "name": "date", "value": "", "type": "query", "description": "the most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "starting date when requesting a range of results" }, { "name": "max", "value": "", "type": "query", "description": "the maximum number of videos to include for each group of results Default: 10." }, { "name": "period", "value": "", "type": "query", "description": "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" }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" }, { "name": "complete_stats", "value": "", "type": "query", "description": "Request complete stats (views, impressions and watch_time) instead of plays only Default: false." }, { "name": "check_stats_module", "value": "", "type": "query", "description": "Check for stats module to short-circuit the request Default: true." }, { "name": "summarize", "value": "", "type": "query", "description": "Return summary data instead of detailed period data" } ] }, "docs": "View a site's video plays" }, { "info": { "name": "View the details of a single video", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/video/:post_id", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain" }, { "name": "post_id", "value": "", "type": "path", "description": "The video's id" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "statType", "value": "", "type": "query", "description": "The metric to return: views|plays|impressions|watch_time|retention_rate|all. views and plays are equivalent. Default: 'views'." }, { "name": "period", "value": "", "type": "query", "description": "The bucket granularity: day|week|month|year. Without date/start_date/num it selects the legacy trailing window instead. Default: 'day'." }, { "name": "num", "value": "", "type": "query", "description": "Number of periods to include in the results. -1 returns the full series since the video was published." }, { "name": "date", "value": "", "type": "query", "description": "The most recent day to include in results" }, { "name": "start_date", "value": "", "type": "query", "description": "The start date for the results; overrides num" }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset" } ] }, "docs": "View the details of a single video" }, { "info": { "name": "View the total number of views for each post.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/stats/views/posts", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site's id or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "post_ids", "value": "", "type": "query", "description": "comma separated list of post ids. Maximum of 100 post_ids per request." }, { "name": "num", "value": "", "type": "query", "description": "number of days to include in the query. Maximum of 30. Default: 1." }, { "name": "date", "value": "", "type": "query", "description": "the most recent day to include in results, in YYYY-MM-DD format. Defaults to today." }, { "name": "offset", "value": "", "type": "query", "description": "The offset, in hours, from GMT for which to fetch results. If omitted, defaults to site's offset." } ] }, "docs": "View the total number of views for each post." } ] }, { "info": { "name": "general", "type": "folder" }, "items": [ { "info": { "name": "Force immediate sync of top items on a queue", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/sync/now", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID, The site domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Force immediate sync of top items on a queue" }, { "info": { "name": "Status of the current full sync or the previous full sync", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/sync/status", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID, The site domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "List of comma-separated fields to return (see `response_format`)." }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Status of the current full sync or the previous full sync" }, { "info": { "name": "Gets info about a Jetpack blog's core installation", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/translations", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID, The site domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Gets info about a Jetpack blog's core installation" }, { "info": { "name": "Toggle automatic core updates for a Jetpack blog", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/translations", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID, The site domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Toggle automatic core updates for a Jetpack blog" }, { "info": { "name": "Update All Translations installation on a Jetpack blog", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/translations/update", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID, The site domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Update All Translations installation on a Jetpack blog" }, { "info": { "name": "Get counts for available updates", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/updates", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID, The site domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get counts for available updates" } ] }, { "info": { "name": "themes", "type": "folder" }, "items": [ { "info": { "name": "Get information about a theme on WordPress.com.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/themes", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "locale", "value": "", "type": "query", "description": "ISO 639-1 Locale. Default: en." }, { "name": "currency", "value": "", "type": "query", "description": "Currency. Default: USD." }, { "name": "extended", "value": "", "type": "query", "description": "To add additional information. Default: False." } ] }, "docs": "Get information about a theme on WordPress.com." }, { "info": { "name": "Get the active theme of a site.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/themes/mine", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the active theme of a site." }, { "info": { "name": "Change the active theme of a site.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/sites/:site/themes/mine", "params": [ { "name": "site", "value": "", "type": "path", "description": "Site ID or domain" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the active theme of a site." }, { "info": { "name": "Get a list of all available themes on WordPress.com.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/themes", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "locale", "value": "", "type": "query", "description": "ISO 639-1 Locale. Default: en." }, { "name": "currency", "value": "", "type": "query", "description": "Currency. Default: USD" }, { "name": "retired", "value": "", "type": "query", "description": "Include retired themes? Default: false." }, { "name": "extended", "value": "", "type": "query", "description": "To add additional information. Default: False." } ] }, "docs": "Get a list of all available themes on WordPress.com." }, { "info": { "name": "Get a theme on WordPress.com.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/themes/:theme_slug", "params": [ { "name": "theme_slug", "value": "", "type": "path", "description": "The slug of the theme." }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "locale", "value": "", "type": "query", "description": "ISO 639-1 Locale. Default: en." }, { "name": "currency", "value": "", "type": "query", "description": "Currency. Default: USD" }, { "name": "retired", "value": "", "type": "query", "description": "Include retired themes? Default: false." }, { "name": "extended", "value": "", "type": "query", "description": "To add additional information. Default: False." } ] }, "docs": "Get a theme on WordPress.com." } ] }, { "info": { "name": "alternates", "type": "folder" }, "items": [ { "info": { "name": "Get alternates for support article (by ID).", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/support/alternates/:site/posts/:post_ID", "params": [ { "name": "site", "value": "", "type": "path", "description": "Support site ID or domain" }, { "name": "post_ID", "value": "", "type": "path", "description": "The post ID" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "locale", "value": "", "type": "query", "description": "Locale slug" } ] }, "docs": "Get alternates for support article (by ID)." } ] }, { "info": { "name": "tests", "type": "folder" }, "items": [ { "info": { "name": "Test GET requests.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/test/version/:ID/old", "params": [ { "name": "ID", "value": "", "type": "path", "description": "An arbitrary integer" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "id", "value": "", "type": "query", "description": "Another arbitrary integer" }, { "name": "default_string", "value": "", "type": "query", "description": "Default: 'default'." }, { "name": "default_int", "value": "", "type": "query", "description": "Default: 100." }, { "name": "boolean_whitelist_defaults_to_false", "value": "", "type": "query", "description": "false: (default) False; true: True" }, { "name": "boolean_whitelist_defaults_to_true", "value": "", "type": "query", "description": "true: (default) TRUE; false: FALSE" }, { "name": "string_whitelist_defaults_to_foo", "value": "", "type": "query", "description": "foo: (default) Foolish; bar: Barstow" }, { "name": "url", "value": "", "type": "query" }, { "name": "datetime", "value": "", "type": "query" } ] }, "docs": "Test GET requests." }, { "info": { "name": "Test GET requests.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/test/:ID", "params": [ { "name": "ID", "value": "", "type": "path", "description": "An arbitrary integer" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "id", "value": "", "type": "query", "description": "Another arbitrary integer" }, { "name": "default_string", "value": "", "type": "query", "description": "Default: 'default'." }, { "name": "default_int", "value": "", "type": "query", "description": "Default: 100." }, { "name": "boolean_whitelist_defaults_to_false", "value": "", "type": "query", "description": "false: (default) False; true: True" }, { "name": "boolean_whitelist_defaults_to_true", "value": "", "type": "query", "description": "true: (default) TRUE; false: FALSE" }, { "name": "string_whitelist_defaults_to_foo", "value": "", "type": "query", "description": "foo: (default) Foolish; bar: Barstow" }, { "name": "url", "value": "", "type": "query" }, { "name": "datetime", "value": "", "type": "query" } ] }, "docs": "Test GET requests." }, { "info": { "name": "Test POST requests.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/test/:ID", "params": [ { "name": "ID", "value": "", "type": "path", "description": "An arbitrary integer" }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "id", "value": "", "type": "query", "description": "Another arbitrary integer" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test POST requests." } ] }, { "info": { "name": "videos", "type": "folder" }, "items": [ { "info": { "name": "Get the metadata for a specified VideoPress video.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/videos/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The guid of the video" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "birth_month", "value": "", "type": "query", "description": "The month the visitor was born" }, { "name": "birth_day", "value": "", "type": "query", "description": "The day of the month the visitor was born" }, { "name": "birth_year", "value": "", "type": "query", "description": "The year the visitor was born" }, { "name": "metadata_token", "value": "", "type": "query", "description": "Optional. Permissions token" } ] }, "docs": "Get the metadata for a specified VideoPress video." }, { "info": { "name": "Get the chapters for a specified VideoPress video.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/videos/:guid/chapters", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The guid of the video" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "metadata_token", "value": "", "type": "query", "description": "Optional. Auth token" } ] }, "docs": "Get the chapters for a specified VideoPress video." }, { "info": { "name": "Get the poster for a specified VideoPress video.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/videos/:guid/playlist/:format", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The guid of the video" }, { "name": "format", "value": "", "type": "path", "description": "The playlist format, e.g. adaptive, hd-master, or subs-{language} for a subtitle track playlist" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." }, { "name": "metadata_token", "value": "", "type": "query", "description": "Optional. Auth token" } ] }, "docs": "Get the poster for a specified VideoPress video." }, { "info": { "name": "Get the poster for a specified VideoPress video.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/videos/:guid/poster", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The guid of the video" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get the poster for a specified VideoPress video." }, { "info": { "name": "Upload and set a poster for a specified VideoPress video.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/videos/:guid/poster", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The guid of the video" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload and set a poster for a specified VideoPress video." }, { "info": { "name": "Upload a subtitle/caption track for a specified VideoPress video.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/videos/:guid/tracks", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The guid of the video" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload a subtitle/caption track for a specified VideoPress video." }, { "info": { "name": "Delete an existing subtitle/caption track for a specified VideoPress video.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/videos/:guid/tracks/delete", "params": [ { "name": "guid", "value": "", "type": "path", "description": "The guid of the video" }, { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an existing subtitle/caption track for a specified VideoPress video." } ] }, { "info": { "name": "wrangler", "type": "folder" }, "items": [ { "info": { "name": "Get a simple data wrangler test.", "type": "http" }, "http": { "method": "GET", "url": "https://public-api.wordpress.com/rest/v1.1/wrangler/data", "params": [ { "name": "context", "value": "", "type": "query", "description": "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.." }, { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "meta", "value": "", "type": "query", "description": "Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ] }, "docs": "Get a simple data wrangler test." }, { "info": { "name": "Submit answer to a data wrangler test.", "type": "http" }, "http": { "method": "POST", "url": "https://public-api.wordpress.com/rest/v1.1/wrangler/data/answer", "params": [ { "name": "http_envelope", "value": "", "type": "query", "description": "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." }, { "name": "pretty", "value": "", "type": "query", "description": "false: (default); true: Output pretty JSON" }, { "name": "fields", "value": "", "type": "query", "description": "Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title" }, { "name": "callback", "value": "", "type": "query", "description": "An optional JSONP callback function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submit answer to a data wrangler test." } ] } ], "bundled": true }