Jump to content

Community

REST API Documentation

/blog/comments


For requests using an OAuth Access Token for a particular member, only comments the authorized user can view will be included, and all comments on draft entries are excluded


Parameters

Name Type Description
blogs string Comma-delimited list of blog IDs
authors string Comma-delimited list of member IDs - if provided, only topics started by those members are returned
locked int If 1, only comments from entries which are locked are returned, if 0 only unlocked
hidden int If 1, only comments which are hidden are returned, if 0 only not hidden
pinned int If 1, only posts from topics which are pinned are returned, if 0 only not pinned
featured int If 1, only comments from entries which are featured are returned, if 0 only not featured
draft int If 1, only draft entries are returned, if 0 only published. Ignored for requests using an OAuth Access Token for a particular member
sortBy string What to sort by. Can be 'date', 'title' or leave unspecified for ID
sortDir string Sort direction. Can be 'asc' or 'desc' - defaults to 'asc'
page int Page number
perPage int Number of results per page - defaults to 25

Exceptions

This endpoint doesn't throw any exceptions.

Response

Name Type Description
page int The page number for the results being shown
perPage int The number of results that will be on each page
totalResults int The total number of results
totalPages int The number of pages of results
results array of comment objects The results for this page

comment object

Name Type Description
id int ID number
item_id int The ID number of the item this belongs to
author member object Author
date datetime Date
content string The content
hidden bool Is hidden?
url string URL to content

member object

Name Type Description
id int ID number
name string Username
title string Member title
timezone string Member timezone
formattedName string Username with group formatting
ipAddress string IP address used during registration
primaryGroup group object Primary group
secondaryGroups array of group objects Secondary groups
email string Email address
joined datetime Registration date
registrationIpAddress string IP address when registered
warningPoints int Number of active warning points
reputationPoints int Number of reputation points
photoUrl string URL to photo (which will be the site's default if they haven't set one)
photoUrlIsDefault bool Indicates if the value of photoUrl is the site's default
coverPhotoUrl string URL to profile cover photo (will be blank if there isn't one)
profileUrl string|null URL to profile
validating bool Whether or not the validating flag is set on the member account
posts int Number of content item submissions member has made
lastActivity datetime|null Last activity date on the site
lastVisit datetime|null Last distinct visit date on the site
lastPost datetime|null Latest content submission date
profileViews int Number of times member's profile has been viewed
birthday string Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied)
customFields array of fieldgroup objects Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included

group object

Name Type Description
id int ID number
name string Name
formattedName string Name with formatting

fieldgroup object

Name Type Description
name string Group name
fields array of field objects Fields

field object

Name Type Description
name string Field name
value string Value
×
×
  • Create New...