Reviews API

With mobile technology and social networking, users are more accustomed than ever to submitting feedback about the applications they use, web sites they visit, and products and services they purchase. In addition to voicing their own opinions, users like to read what others have to say. It is a continuous cycle of feedback aimed at improving product quality and the user experience.

Using the Reviews API, you can leverage this cycle of feedback to let App Catalog users Like or Dislike apps. Users can also review apps and browse reviews from other users.

The Reviews API lets you:

  • Rate (like/dislike) and review an application
  • List ratings and reviews for a specific application
  • List the number of likes/dislikes for a specific application
  • Lists the number of likes/dislikes for all applications in the organization
  • Check if the Ratings and Reviews feature is enabled or disabled

Resources

POST /v1/applications/(app_psk)/likes/

Rate (Like/Dislike) and Review an Application

Requires user and device context. Use session token returned from POST /catalog/authenticate.

Allows an App Catalog user to like/dislike (thumbs-up/thumbs-down) an application and enter a review. A user can provide a rating without providing a review, but cannot review an app without providing a rating. If the request includes a review, it must include both a title and a comment.

If the user previously liked/disliked and reviewed the app, the rating and review are updated.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/likes/
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/likes/

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer

Header Parameter

X-UDID
(Required) Unique identifier assigned by EASE to the device.
X-TOKEN
(Required) Session token returned by POST /catalog/authenticate.
Content-Type
(Required) Specifies the content type of the body of data sent with the request. Set to: application/json

Data Parameters

like
(Required) User’s app rating (like/dislike). Must be a 0 or 1: 0=dislike; 1=like For Example: "like": 0 or "like": 1
title
(Required if “comment” is included) Title of the review. This parameter allows the user to provide a brief
summary or tagline for his/her review. For example: “The best app ever!” This parameter is required if comment is included with the request.
comment
(Optional) Review comment. This parameter allows the user to provide a more detailed review of the app to accompany the review title. If this parameter is included, title is required.

Example Request

curl -X POST https://na01ws.apperian.com/v1/applications/4333/likes/ --header "Content-Type: application/json" --header "X-TOKEN: hShU5OD-SiadD8gyC_K4HA" --data '{"like":1, "title":"Changed my life!", "comment":"I am not easy to impress, but this app has truly made me a more productive person. I highly recommend it. You will not be sorry!"}'

Example Response

The following response indicates that the rating (and review, if provided) posted successfully. This is the same response for both a like or dislike.

{
     "liked": true
}

The follow response indicates that the authenticated user does not have permission to access the app.

{
     "error": {
       "code": 11,
       "message": "User is not allowed to access resource id 16776",
       "guid": "fdcb6f9f-f808-43c8-ab69-7bf642202555",
       "error_details": null
     }
}

The following response indicates that comment was included without title.

{
     "error": {
       "code": 20,
       "message": "A comment cannot be provided without a title",
       "guid": "20c31154-34d5-482f-9bf3-16f14c8453bc",
       "error_details": null
     }
}
GET /v1/applications/(app_psk)/likes/reviews/

List Rating and Review Data for a Specific Application

Requires user and device context. Use session token returned from POST /catalog/authenticate.

Returns rating and review data for a specific application. If a user submitted a review and later updated it, the response shows both the date the review was first created and the date it was updated.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/likes/reviews/
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/likes/reviews/

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer

Header Parameter

X-UDID
(Required) Unique identifier assigned by EASE to the device.
X-TOKEN
(Required) Session token returned by POST /catalog/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/4333/likes/reviews/ --header "X-UDID: 90b0e24db7f650bbec684b60c6da855e4c98b28b" --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

{
     "reviews": [
       {
         "comment": "I am not easy to impress, but this app has truly made me a more productive person.",
         "psk": 4017,
         "updated": "2015-07-26T00:41:37.509792+00:00",
         "like": 0,
         "title": "Changed my life!",
         "created": "2015-07-25T23:56:11.469637+00:00",
         "device": {
           "psk": 74383,
           "user": {
             "psk": 99286,
             "first_name": "Robert",
             "last_name": "James"
           }
         },
         "version": {
           "psk": 49627
         },
         "user": {
           "psk": 99286,
           "first_name": "Robert",
           "last_name": "James"
         },
         "vote": 1,
         "application": {
           "psk": 16776
         }
       }
     ],
     "paging": {
       "total": 1,
       "next": null,
       "previous": null
     },
     "user_review": {
       "comment": "I am not easy to impress, but this app has truly made me a more productive person.",
       "psk": 4017,
       "updated": "2015-07-26T00:41:37.509792+00:00",
       "title": "Changed my life!",
       "created": "2015-07-25T23:56:11.469637+00:00",
       "device": {
         "psk": 74383,
         "user": {
           "psk": 99286,
           "first_name": "Robert",
           "last_name": "James"
         }
       },
       "version": {
         "psk": 49627
       },
       "user": {
         "psk": 99286,
         "first_name": "Robert",
         "last_name": "James"
       },
       "vote": 1,
       "application": {
         "psk": 16776
       }
     },
     "reviews_enabled": true
   }
GET /v1/applications/(app_psk)/reviews/analytics/num_likes_for_app/

List Likes/Dislikes for a Specific Application

Requires user and device context. Use session token returned from POST /catalog/authenticate.

Returns the number of likes and dislikes for a specific application.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/reviews/analytics/num_likes_for_app/
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/reviews/analytics/num_likes_for_app/

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer

Header Parameter

X-UDID
(Required) Unique identifier assigned by EASE to the device.
X-TOKEN
(Required) Session token returned by POST /catalog/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/4333/reviews/analytics/num_likes_for_app/ --header "X-UDID: 90b0e24db7f650bbec684b60c6da855e4c98b28b" --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

This app was rated by 8 users: 6 likes and 2 dislikes.

{
     "number_of_likes": {
       "16776": {
         "num_dislikes": 2,
         "num_likes": 6
       }
     }
}
GET /v1/applications/reviews/analytics/likes/

List Likes/Dislikes for All Applications

Requires user and device context. Use session token returned from POST /catalog/authenticate.

Return the number of likes and dislikes for each application that can be rated in the authenticated user’s organization. Users can rate native apps only (not web apps or public apps). Apps are listed by app PSK.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/reviews/analytics/likes/
Europe https://eu01ws.apperian.eu/v1/applications/reviews/analytics/likes/

URL Parameters

None

Header Parameter

X-UDID
(Required) Unique identifier assigned by EASE to the device.
X-TOKEN
(Required) Session token returned by POST /catalog/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/reviews/analytics/likes/ --header "X-UDID: 90b0e24db7f650bbec684b60c6da855e4c98b28b" --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

{
     "number_of_likes": {
       "10017": {
         "num_dislikes": 0,
         "num_likes": 0
       },
       "5714": {
         "num_dislikes": 0,
         "num_likes": 0
       },
       "5713": {
         "num_dislikes": 0,
         "num_likes": 0
       }
     }
}
GET /v1/applications/reviews/enabled/

Check If Ratings and Reviews is Enabled

Requires user context. Use session token returned from POST /catalog/authenticate.

Identifies whether the Ratings and Reviews feature is enabled for the authenticated user’s organization. If the feature is disabled, the Like/Dislike buttons are hidden in the App Catalog and the Reviews tab is disabled (grayed out).

Note

To enable/disable the Ratings and Reviews feature for your organization, contact Apperian Customer Support at support@apperian.com. You cannot enable/disable the feature via the API.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/reviews/enabled/
Europe https://eu01ws.apperian.eu/v1/applications/reviews/enabled/

URL Parameters

None

Header Parameter

X-UDID
(Required) Unique identifier assigned by EASE to the device.
X-TOKEN
(Required) Session token returned by POST /catalog/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/reviews/enabled/ --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

{
     "reviews_enabled": true
}