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.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.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.
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 |
The example below retrieves all story and pathway reviews for a given app.
curl -X POST \
v1/analytics/reviews/apps \
-H 'Authorization: Basic <Your Base64 Encoded Token>'\
-d '{
"items" : ["Falkor"]
}'
The example below retrieves reviews for a collection of stories.
curl -X POST \
v1/analytics/reviews/stories \
-H 'Authorization: Basic <Your Base64 Encoded Token>'\
-d '{
"items" : ["Story A","Story B","Story C",...]
}'
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.Key | Value |
Ratings | Object
With average rating and number of users that have rated the content. |
Comments | Array Comment Items |
Key | Value |
firstname | String |
lastname | String |
email | String |
telephone | String |
country | String |
city | String |
comment | String |
timestamp | String |
item | Object
The related content item |
{
"status": "success",
"data": [
{
"app": {
"name": "Falkor",
"version": "2.10.1",
"type": "app",
"ID": "io.falkor.demo"
},
"reviews": {
"ratings": {
"average": 4.3,
"users": 10427
},
"comments": [
{
"firstname": "User",
"lastname": "One",
"email": "[email protected]",
"telephone": "",
"country": "United Kingdom",
"city": "London",
"rating": 4,
"comment": "This is great thanks! 😀",
"timestamp": "2021-03-12T16:59:42+02:00",
"item": {
"type": "story",
"name": "Workplace Culture"
}
},
{
"firstname": "User",
"lastname": "Two",
"email": "[email protected]",
"telephone": "",
"country": "********",
"city": "********",
"rating": 5,
"comment": "This was very informative - 5 Stars",
"timestamp": "2021-03-12T16:12:06+02:00",
"item": {
"type": "pathway",
"name": "Onboarding Pathway"
}
},
...etc
]
}
},
...etc
],
"hash": "67d5e81356c9ad8f419e38cfbbb6b396",
"response_time": 0.19236993789672852
}
Last modified 1yr ago