Reviews
The Reviews endpoint allows viewing reviews and comments. This end point allows reviews to be viewed for Apps, Stories OR Pathways.
Streams items do not use the reviews endpoint, instead use the /analytics/stream-ratings
endpoint.
Available Reviews Endpoints
v1/analytics/reviews/apps
Get reviews for all content published for an app or a list of apps.
v1/analytics/reviews/pathways
Get reviews for a pathway or a list of pathways.
v1/analytics/reviews/stories
Get reviews for a story or a list of stories.
Parameters
The items parameter allows you to filter items based on the name or ID of the item. If the item parameter is not provided the endpoint will return the latest 10 items.
Parameters
The items parameter allows you to filter items based on the name or ID of the item. If the item parameter is not provided the endpoint will return the latest 10 items.
Key | Value |
items | Array of Strings Item name or ID |
Examples
Get All Content Reviews On An App
The example below retrieves all story and pathway reviews for a given app.
Get Reviews On Several Stories
The example below retrieves reviews for a collection of stories.
Success Response
Whichever reviews
endpoint you are using a successful response will return an array of items with each item containing a context item (app, pathway or story) and corresponding reviews
data. The example below shows a successful response when using the reviews/apps
endpoint.
Review Item
Key | Value |
Ratings | Object With average rating and number of users that have rated the content. |
Comments | Array Comment Items |
Comment Item
Key | Value |
firstname | String |
lastname | String |
String | |
telephone | String |
country | String |
city | String |
comment | String |
timestamp | String |
item | Object The related content item |
Last updated