GET /sites/$site/comments/

Get a list of recent comments.

Resource Information

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

Method Parameters

Parameter Type Description
$site (int|string) Site ID or domain

Query Parameters

Parameter Type Description
context (string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
false:
(default)
true:
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.
number (int) The number of comments to return. Limit: 100. When using hierarchical=1, number refers to the number of top-level comments returned. Default: 20.
offset (int) 0-indexed offset. Not available if using hierarchical=1.
page (int) 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.
order (string)
DESC:
(default) Return comments in descending order from newest to oldest.
ASC:
Return comments in ascending order from oldest to newest.
hierarchical (bool)
false:
(default)
true:
(BETA) Order the comment list hierarchically.
after (iso 8601 datetime) Return comments dated on or after the specified datetime. Not available if using hierarchical=1.
before (iso 8601 datetime) Return comments dated on or before the specified datetime. Not available if using hierarchical=1.
type (string)
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.
status (string)
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.

Response Parameters

Parameter Type Description
found (int) The total number of comments found that match the request (ignoring limits, offsets, and pagination).
site_ID (int) The site ID
comments (array) An array of comment objects.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
403 unauthorized User cannot view post
403 unauthorized User cannot access this private blog.
403 unauthorized User cannot access this restricted blog
403 unauthorized User cannot read unapproved comment
403 unauthorized User cannot edit comment
403 unauthorized User cannot read non-approved comments
404 unknown_comment Unknown comment
400 invalid_context Invalid API CONTEXT
404 unknown_post Unknown post
400 invalid_number The NUMBER parameter must be less than or equal to 100.

Example

curl 'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/comments/?number=2'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/comments/?number=2',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "found": 126878,
    "site_ID": 3584907,
    "comments": [
        {
            "ID": 256352,
            "post": {
                "ID": 38891,
                "title": "An All-New Media Library for the WordPress iOS App",
                "type": "post",
                "link": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/posts\/38891"
            },
            "author": {
                "ID": 79,
                "login": "ryan",
                "email": false,
                "name": "Ryan Boren",
                "first_name": "Ryan",
                "last_name": "Boren",
                "nice_name": "ryan",
                "URL": "http:\/\/boren.blog\/",
                "avatar_URL": "https:\/\/0.gravatar.com\/avatar\/c22398fb9602c967d1dac8174f4a1a4e?s=96&d=retro",
                "profile_URL": "https:\/\/en.gravatar.com\/ryan",
                "site_ID": 78
            },
            "date": "2017-06-22T18:14:13+00:00",
            "URL": "http:\/\/en.blog.wordpress.com\/2017\/06\/21\/an-all-new-media-library-for-the-wordpress-ios-app\/#comment-256352",
            "short_URL": "http:\/\/wp.me\/pf2B5-a7h%23comment-256352",
            "content": "<p>I notice that through the media library we have access to Image Decription, allowing us to provide accessible alt text. I do not see access to this through the editor when adding images to posts. The Media Settings modal shows only Alignment and Size. How do we add accessible alt text from editor flows? The support page seems out of date. The options shown in the screenshots there are gone. <\/p>\n<div class=\"embed-twitter\">\n<blockquote class=\"twitter-tweet\" data-width=\"500\">\n<p lang=\"en\" dir=\"ltr\">Where did alt text editing go, <a href=\"https:\/\/twitter.com\/WordPressiOS\">@WordPressiOS<\/a>? This page seems out of date. <a href=\"https:\/\/t.co\/wFMqOsl6DF\">https:\/\/t.co\/wFMqOsl6DF<\/a><\/p>\n<p>&mdash; Ryan Boren (@rboren) <a href=\"https:\/\/twitter.com\/rboren\/status\/877680082629918720\">June 22, 2017<\/a><\/p><\/blockquote>\n<p><script async src=\"\/\/platform.twitter.com\/widgets.js\" charset=\"utf-8\"><\/script><\/div>\n<p>Note: I’m on the beta channel, not production.<\/p>\n",
            "status": "approved",
            "parent": false,
            "type": "comment",
            "like_count": 0,
            "i_like": false,
            "meta": {
                "links": {
                    "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/256352",
                    "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/256352\/help",
                    "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907",
                    "post": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/posts\/38891",
                    "replies": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/256352\/replies\/",
                    "likes": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/256352\/likes\/"
                }
            }
        },
        {
            "ID": 256305,
            "post": {
                "ID": 38891,
                "title": "An All-New Media Library for the WordPress iOS App",
                "type": "post",
                "link": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/posts\/38891"
            },
            "author": {
                "ID": 59013455,
                "login": "ssamess",
                "email": false,
                "name": "Sarah",
                "first_name": "Sarah",
                "last_name": "",
                "nice_name": "ssamess",
                "URL": "http:\/\/samesfoley.wordpress.com",
                "avatar_URL": "https:\/\/1.gravatar.com\/avatar\/7157d19b37ff494140ba6a3362b888da?s=96&d=retro",
                "profile_URL": "https:\/\/en.gravatar.com\/ssamess",
                "site_ID": 127835557
            },
            "date": "2017-06-21T18:14:59+00:00",
            "URL": "http:\/\/en.blog.wordpress.com\/2017\/06\/21\/an-all-new-media-library-for-the-wordpress-ios-app\/#comment-256305",
            "short_URL": "http:\/\/wp.me\/pf2B5-a7h%23comment-256305",
            "content": "<p>Ah, great news! I’m excited to try this out, thanks WordPress!<\/p>\n",
            "status": "approved",
            "parent": false,
            "type": "comment",
            "like_count": 1,
            "i_like": false,
            "meta": {
                "links": {
                    "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/256305",
                    "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/256305\/help",
                    "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907",
                    "post": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/posts\/38891",
                    "replies": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/256305\/replies\/",
                    "likes": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/256305\/likes\/"
                }
            }
        }
    ]
}