Jump to content

Community

REST API Documentation

/cms/reviews/{database_id}


Get list of comments

For requests using an OAuth Access Token for a particular member, only reviews the authorized user can view will be included


Parameters

Name Type Description
categories string Comma-delimited list of category 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 events 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
featured int If 1, only comments from events which are featured are returned, if 0 only not featured
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

Code Message Description
2T312/1 INVALID_DATABASE The database ID does not exist or the authorized user does not have permission to view it

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 review objects The results for this page

review object

Name Type Description
id int ID number
item int The ID number of the item this belongs to
author member object Author
date datetime Date
rating int The number of stars this review gave
votesTotal int The number of users that have voted if this review was helpful or unhelpful
votesHelpful int The number of users that voted helpful
content string The content
hidden bool Is hidden?
url string URL to content
authorResponse tring|null object The content item's author's response to the review, if any

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 tring|null object 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 atetime|null object Last activity date on the site
lastVisit atetime|null object Last distinct visit date on the site
lastPost atetime|null object 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...