ReviewSpotter API  Version 4.3.2

Standard API error codes

Sample error response :

{
  "status": "unsuccessful",
  "results": [
    {
      "error": "",
      "message": ""
    }
  ]
}
}

Standard API success codes

ReviewSpotter APIs are hosted in a Sandbox environment for you to use and play around for development or testing purposes.

Under this section you will be provided with functional methods to signup and generate the Access token. It is important to be aware that a valid access token is needed to keep the system functionalities active.

Signup with a new account

Create a new ReviewSpotter account, you may create any number of Sites in an account.

URL Structure : /users

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Retrieve rs token

A successful login will provide you a ReviewSpotter token which can be later used to generate an Access Token when the APP key is given.

URL Structure : /auth/token/rs

Method : POST

Parameters :

Sample response :

{
   "rs_token": "",
   "refresh_token": "",
   "expires_in": ""
}

Retrieve an access token

You can retrieve an application specific access token here.

URL Structure : /auth/token/access

Method : GET

Parameters :

Sample response :

{
  "access_token": "",
  "refresh_token": "",
  "expires_in": ""
}

Refresh the user access token

This method can be used to refresh the user access token. In such cases the user will be re-authenticated.

URL Structure : /auth/token/refresh

Method : GET

Parameters :

Sample response :

{
   "access_token": "",
   "refresh_token": "",
   "expires_in": ""
}

Retrieve transaction key

Retrieve a one time access token to communicate between API calls.

URL Structure : /auth/token/transaction

Method : POST

Parameters :

Sample response :

 {
   "access_token": "",
   "expires_in": ""
}

Provides functionalities to create new applications and also modify and delete existing applications in the system.

Create an application

Creates a new application in the ReviewSpotter system.

URL Structure : /apps

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Retrieve all applications

Gives you summarized information on all available applications

URL Structure : /apps

Method : GET

Parameters :

Sample response :

 {
  "status": "successful",
  "results": [
    {
      "appKey": ",
      "appURL": "",
      "description": "",
      "appEdition": "",
      "appName": "",
      "appOwner": "",
      "appSettings": {
        "replyEnabled": true,
        "voteEnabled": true,
        "reportEnabled": true,
        "moderationEnabled": false,
        "publishedEmailEnabled": true,
        "autoModerationType": "",
        "badReviewDefinition": "",
        "badReviewOverallThreshold": "",
        "badReviewRatingThreshold": "",
        "badReviewSentimentThreshold": "",
        "ttl": "",
        "public": true
      }
    }
  ]
}

Retrieve an application

Gives you detailed information on a particular application, when the app-key is specified.

URL Structure : /apps/{app-key}

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "appKey": "",
      "appSecret": "",
      "appName": "",
      "description": "",
      "appURL": "",
	  "appLogo": "",
	  "headerLogo": "",
      "deleted": "",
      "status": "",
      "appEdition": "",
      "version": "",
      "buildVersion": "",
      "appOwner": "",
      "createdTime": "",
      "appSettings": {
        "replyEnabled": "",
        "voteEnabled": "",
        "reportEnabled": "",
        "moderationEnabled": "",
        "publishedEmailEnabled": "",
        "autoModerationType": "",
        "badReviewDefinition": "",
        "badReviewOverallThreshold": "",
        "badReviewRatingThreshold": "",
        "badReviewSentimentThreshold": "",
        "ttl": "",
        "public": ""
      },
      "emailServerSettings": "",
      "lastModifiedUser": "",
      "lastModifiedTime": "",
      "publicToken": "",
      "createdByUserId": ""
    }
  ]
}

Modify an application

Modifies an application when an app-key is specified.

URL Structure : /apps/{app-key}

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Change application secret

Changes the application secret, the application secret is needed to derive the transaction key.

URL Structure : /apps/{app-key}/app-secret

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Delete an application

Deletes a specific application when the app-key is specified.

URL Structure : /apps/{app-key}

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Modify Email Settings

Modifies an application email server settings when an app-key is specified

URL Structure : /apps/{app-key}/email-setting

Method : PUT

Parameters :

Sample response :

 {
  {
  "status": "successful",
  "results": [
    {
      "message": "App modified"
    }
  ]
}
}

Retrieve Email Settings

Gives you information on specified application email server settings

URL Structure : /apps/{app-key}/email-setting

Method : GET

Parameters :

Sample response :

 {
  {
  "status": "successful",
  "results": [
    {
      "smtpHost": "",
      "smtpPort": "",
      "smtpAuth": true,
      "smtpStarTLS": false,
      "smtpSSL": true,
      "transportProtocol": "",
      "smtpSocketFactoryPort": "",
      "smtpSocketFactoryClass": "",
      "senderEmail": "",
      "senderName": "",
      "username": "",
      "password": ""
    }
  ]
}
}

Delete Email Settings

Deletes a specific application email server settings when the app-key is specified.

URL Structure : /apps/{app-key}/email-setting

Method : DELETE

Parameters :

Sample response :

 {
  {
  "status": "successful",
  "results": [
    {
      "message": "App modified"
    }
  ]
}
}

Send Test Email

Allows you to verify the given email server settings

URL Structure : /apps/{app-key}/email-setting/test-email

Method : POST

Parameters :

Sample response :

 {
  {
  "status": "successful",
  "results": [
    {
      "message": "Sent test email"
    }
  ]
}
}

Retreive level definition

Gives you information on specified user level definitions for the application

URL Structure : /apps/{app-key}/level-definitions

Method : GET

Parameters :

Sample response :

								{
  "status": "successful",
  "results": [
    {
      "modelVersion": "DEFAULT",
      "levelDefinitions": [
        {
          "level": ,
          "levelName": "",
          "maxScorePointsToAchieve":
        }
      ]
    }
  ]
}
								

Modify level definition

Allows you to modify specified user level definitions for the application

URL Structure : /apps/{app-key}/level-definitions

Method : PUT

Parameters :

Sample response :

 {
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

This controller holds the functionality that relates to visualizing and modifying user information.

Retrieve account information

Providing the access token you can retrieve your account details such as email, first and last names, assigned user roles, and images if you have uploaded.

URL Structure : /users/me

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "email": "",
      "userId": "",
      "firstName": "",
      "lastName": "",
      "imageURL": "",
      "defaultAppKey": "",
      "systemRole": "",
      "appRoles": {},
      "customRoles": {},
      "appEntityLimitationUsed": {},
      "appAllowedEntities": {},
      "provider": "",
      "emailConfirmed": ""
    }
  ]
}

Modify account details

Allows you to modify user account information. Some parameters should be provided in a JSON format.

URL Structure : /users/me

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Change account password

Provides you with the option to change the current account password. The new password should contain minimum 8 characters.

URL Structure : /users/me/password

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Delete your account

Allows you to delete the account.

URL Structure : /users/me

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": []
}

Some general methods to load summarized information of the application.

Load form template components

loads all from templates mapped with an Application.

URL Structure : /apps/{app-key}/options/form-components

Method : GET

Parameters :

Sample response :

{
   "status": "successful",
   "results":    [
            {
         "key": "",
         "value": ""
      }
   ]
}

Load role wise user rights

Load user role wise system privileges defined in an application.

URL Structure : /apps/{app-key}/options/roles

Method : GET

Parameters :

Sample response :

 {
  "status": "successful",
  "results": [
    {
      "rights": [],
      "roleKey": "",
      "name": "",
      "roleDescription": "",
      "customRole": ""
    }
  ]
}

Create a review model

This will create a new review model for a particular Entity Type.

URL Structure : /apps/{app-key}/entity-types

Method : POST

Parameters :

Sample response :

 {
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Retrieve all review models

This will retrieve a summarized information array all review models in an application.

URL Structure : /apps/{app-key}/entity-types

Method : GET

Parameters :

Sample response :

{
   "status":"successful",
   "results":[
      {
         "name":"",
         "imageUrl":"",
   "publicVisibility": "",
         "model":{
            "overall":{
               "key":"",
               "description":"",
               "writeEnabled":"",
               "readEnabled":"",
               "usedAsMetadata":""
            },
         }
      }
   ],
   "successful":true
}

Retrieve review model

Retrieves an array with detailed information of a review model.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/model

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "key": "",
      "description": "",
      "writeEnabled": "",
      "readEnabled": "",
      "usedAsMetadata": ""
    }
]
}
	

Create an entity

Entities are created under Entity Types.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Update an entity

Update details of a entity that has been already created.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/update

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Retrieve all entities

This will provide you with summarized information of all available entities mapped with the Entity type.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "appKey": "",
      "globalEntityId": "",
      "globalEntityName": "",
      "entityType": "",
      "entityId": "",
      "name": "",
      "description": "",
      "currentFormTemplateKey": "",
      "currentViewTemplateKey": "",
      "props": [],
      "imageUrl": "",
      "thumbnailUrl": "",
      "deleted": "",
      "groups": [],
      "createdTime": "",
      "createdUser": "",
      "updateConversationId": "",
     "associatedEntities": [],
    "currentAttachableFormTemplateKey": "",
      "readyToProcess": "",
      "reviewSummary": {
        "readyToProcess": "",
        "ratingStats": {
           "ALL:ALL": {
           "rating": 0,
           "reviewCount": 0
           },
        }
      },
   "suggestedEntity": "",
   "suggestedEntityDetail": "",
   "publicPageVisible": ""
    }
   ],
  "pagination": {
    "totalCount": "",
    "totalPages": "",
    "currentPage": "",
    "perPage": ""
  }
}

Retrieve an entity

Retrieves detailed information on a particular Entity when entity-id is provided.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}

Method : GET

Parameters :

Sample response :

 {
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "appKey": "",
      "globalEntityId": "",
      "globalEntityName": "",
      "entityType": "",
      "entityId": "",
      "name": "",
      "description": "",
      "currentFormTemplateKey": "",
      "currentViewTemplateKey": "",
      "props": [],
      "imageUrl": "",
	"thumbnailUrl": "",
      "deleted": "",
      "groups": [],
      "createdTime": "",
  	 "createdUser": "",
      "updateConversationId": "",
	   "associatedEntities": [],
      "currentAttachableFormTemplateKey": "",
      "readyToProcess": "",
  "reviewSummary": {
        "readyToProcess": "",
        "ratingStats": {
           "ALL:ALL": {
           "rating": 0,
           "reviewCount": 0
           },
        }
      },
   "suggestedEntity": "",
   "suggestedEntityDetail": "",
   "publicPageVisible": ""
    }
  ]
}

Add properties to an entity

This will add new properties to a particular entity when the entity-id is provided.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}/properties

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Modify an entity

Modify an existing entity.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}/name

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Add associated review sites

Provides an option to combine feedback forms of selected associate review sites.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}/attach

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Retreive associated review sites

Retrieve all associated sites of a particular Review Site.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}/attached-entities

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {}
  ]
}

Modify associated review sites

Modify associated sites of a particular Review Site.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}/attach

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {}
  ]
}

Remove associated review sites

Remove associated sites of a particular Review Site.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}/attach

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {}
  ]
}

Retreive suggested sites

Retrive all suggested sites of particular application

URL Structure : /apps/{app-key}/suggested-entities

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "appKey": "",
      "globalEntityId": ,
      "globalEntityName": ,
      "entityType": "",
      "entityId": "",
      "name": "",
      "description": "",
      "currentFormTemplateKey": ,
      "currentViewTemplateKey": ,
      "props": [
        {
          "key": "",
          "value": "",
          "type": ""
        }
      ],
      "imageUrl": "",
      "thumbnailUrl": "",
      "deleted": false,
      "groups": [],
      "createdTime": ,
      "createdUser": "",
      "updateConversationId": "",
      "associatedEntities": [],
      "currentAttachableFormTemplateKey": ,
      "readyToProcess": true,
      "reviewSummary": {
        "readyToProcess": true,
        "ratingStats": {
          "ALL:ALL": {
            "rating": 0,
            "reviewCount": 0
          }
        }
      },
      "suggestedEntity": true,
      "suggestedEntityDetail": {
        "currentStatus": "SUGGESTED",
        "suggestedEntityHistory": [
          {
            "performedUserId": "",
            "actionTime": ,
            "status": "SUGGESTED",
            "mergedEntity": null
          }
        ],
        "currentMergedEntity": null
      },
      "publicPageVisible": false
    }
  ],
  "pagination": {
    "totalCount": 1,
    "totalPages": 1,
    "currentPage": 1,
    "perPage": 5000
  }
}

Create suggested entity and add review

Provides an option to suggest a site and add a review

URL Structure : /apps/{app-key}/suggested-entities/suggestions

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "suggestedEntityId": "",
      "reviewId": ""
    }
  ]
}

Modify suggested entity status

Method to update specific application suggested entity status

URL Structure : /apps/{app-key}/suggested-entities/{entity-id}

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    ""
  ]
}

Accept suggested entities

Option to accept suggested entity

URL Structure : /apps//{app-key}/suggested-entities/{entity-id}/accept

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    "message":""
  ]
}

Modify Entity Type

Public visibility of a particular Entity Type can be modified here.

URL Structure : /apps/{app-key}/entity-types

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Modify Entity Type Priority

Entity type priority can be modified according to user preference

URL Structure : /apps/{app-key}/entity-types/priorities

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Add review model parameter

This will add a new model parameter to the the Review Model.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/model/parameters

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Modify review model parameter

Modify an existing review model parameter.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/model/parameters/{parameter-key}

Method : POST

Parameters :

Sample response :

 {
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Set current form template

Mapping a from template as the current from.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}/form

Method : PUT

Parameters :

Sample response :

 {
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Set current sub form template

Mapping an available form as a sub form, which will be aggregated with associated review sites.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}/attachable-form

Method : PUT

Parameters :

Sample response :

 {
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Set current view template

Set the view template of an entity.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}/view

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Delete an entity

This will delete an existing Entity under an Entity Type.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/entities/{entity-id}

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Includes all system controls based on review site grouping in an application.

Create application groups

Create a new group that belongs to a particular site type.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/groups

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": "",
      "key": ""
    }
  ]
}

Retrieve all application groups

Retrieves existing groups created in a particular Site type.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/groups

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "groupId": "",
      "groupName": "",
      "entityType": "",
      "appKey": "",
      "entities": [],
      "followUpTemplates": [],
      "formTemplates": [],
      "deleted": "",
      "groupOwner": "",
      "createdTime": ""
    }
  ]
}}

Assign a review site to a group

Add review sites to existing groups in the application.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/groups/{group-id}/entities

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Remove review sites from group

Remove review sites from assigned groups.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/groups/{group-id}/entities

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Delete groups from application

Delete an existing review site group from the application.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/groups/{group-id}

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": "",
      "key": ""
    }
  ]
}

Includes controls of Customizing and managing user groups in the system.

Create user groups

Create a new user group that belongs to a particular entity.

URL Structure : /apps/{app-key}/users/groups

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": "",
      "key": ""
    }
  ]
}

Retrieve all user groups

Can be used to retrieve existing user groups created in an application.

URL Structure : /apps/{app-key}/users/groups

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "groupId": "",
      "groupName": "",
      "appKey": "",
      "entityType": "",
      "assignedAppUsers": [],
      "assignedInvitedUsers": [],
      "mappedAppGroups": [],
      "mappedEntities": {},
      "deleted": false,
      "groupOwner": "",
      "createdTime": ""
    }
  ]
}

Edit user group

Edit existing user groups available an application.

URL Structure : /apps/{app-key}/users/groups/{group-id}

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Add user to the group

Allows you to add users to an existing user group.

URL Structure : /app/{app-key}/user-group/{group-id}/user

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Remove user from group

Includes the feature of removing users form existing user groups.

URL Structure : /app/{app-key}/user-group/{group-id}

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Delete user group

Delete an existing user group from the application.

URL Structure : /apps/{app-key}/users/groups/{group-id}

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Create a form template

Allows you to create from templates per Entity Type.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/form-templates

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": "",
      "key": ""
    }
  ]
}

Retrieve all form templates

Retrieves a list of available from templates. This is a summarized information array of templates in an application.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/form-templates

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "templateId": "",
      "templateName": "",
      "createdUser": "",
      "createdTime": "",
      "formDescription": "",
      "thankYouNote": "",
      "formHeaderImage": "",
      "lastModifiedUser": "",
      "lastModifiedTime": "",
      "appKey": "",
      "entityType": "",
      "apiCall": "",
      "entityMappedApiCall": "",
      "embeddableScript": "",
      "deleted": "",
      "defaultFormTemplate": "",
	  "defaultAttachableFormTemplate": "",
      "mappedViewTemplateKey": "",
      "components": {
        "0": {
          "cmpId": "",
          "component": "",
          "parameterKey": "",
          "required": "",
          "label": "",
          "description": "",
          "attributes": [
            {
              "key": "",
              "value": ""
            }
          ],
          "options": [
            {
              "key": "",
              "value": ""
            }
          ],
		 "publicViewVisible": ""
        }
      },
      "embeddedEntities": [],
      "groups": []
    }
  ]
}

Modify a form template

Modifies a particular form template when a form-template-key is provided.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/form-templates/{form-template-id}

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Retrieve a form template

Retrieves detailed information of a particular form template.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/form-templates/{form-template-id}

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "templateId": "",
      "templateName": "",
      "createdUser": "",
      "createdTime": "",
      "formDescription": "",
      "thankYouNote": "",
      "formHeaderImage": "",
      "lastModifiedUser": "",
      "lastModifiedTime": "",
      "appKey": "",
      "entityType": "",
      "apiCall": "",
      "entityMappedApiCall": "",
      "embeddableScript": "",
      "deleted": "",
      "defaultFormTemplate": "",
      "mappedViewTemplateKey": "",
      "components": {
        "0": {
          "cmpId": "",
          "component": "",
          "parameterKey": "",
          "required": "",
          "label": "",
          "description": "",
          "attributes": [
            {
              "key": "",
              "value": ""
            }
          ],
          "options": [
            {
              "key": "",
              "value": ""
            }
          ],
		 "publicViewVisible": true
        }
      },
      "embeddedEntities": [],
      "groups": []
    }
  ]
}

Delete a form template

Deletes a particular form template when the from-template-key id provided.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/form-templates/{form-template-id}

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Create view template

Create a new template to visualize review models.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/view-templates

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": "",
      "key": ""
    }
  ]
}

Retrieve all view templates

Provides you with a summarized information array of all available View

URL Structure : /apps/{app-key}/entity-types/{entity-type}/view-templates

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "templateId": "",
      "templateName": "",
      "appKey": "",
      "entityType": "",
      "createdUser": "",
      "createdTime": "",
      "lastModifiedUser": "",
      "lastModifiedTime": "",
      "components": {
        "0": {
          "parameterKey": "",
          "component": "",
          "label": "",
		  "publicViewVisible": ""
        }
      },
      "editTemplateId": "",
      "replyEnabled": "",
      "editEnabled": "",
      "deleteEnabled": "",
      "voteEnabled": "",
      "socialShareEnabled": "",
      "apiCall": "",
      "embeddableScript": "",
      "deleted": "",
      "defaultViewTemplate": ""
    }
  ]
}
Response Code

Modify a view template

Modifies a specific template when the view-template-key is provided.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/view-templates/{view-template-id}

Method : PUT

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Load view template

Load a particular view template when the view-template-key is provided.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/view-templates/{view-template-id}

Method : GET

Parameters :

Sample response :

 {
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "templateId": "",
      "templateName": "",
      "appKey": "",
      "entityType": "",
      "createdUser": "",
      "createdTime": "",
      "lastModifiedUser": "",
      "lastModifiedTime": "",
      "components": {
        "0": {
          "parameterKey": "",
          "component": "",
          "label": "",
		  "publicViewVisible": ""
        }
      },
      "editTemplateId": "",
      "replyEnabled": "",
      "editEnabled": "",
      "deleteEnabled": "",
      "voteEnabled": "",
      "socialShareEnabled": "",
      "apiCall": "",
      "embeddableScript": "",
      "deleted": "",
      "defaultViewTemplate": ""
    }
  ]
}

Delete view template

Deletes an an existing view template when the view-template-key is specified.

URL Structure : /apps/{app-key}/entity-types/{entity-type}/view-templates/{view-template-id}

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Provides all functionalities to manipulate aggregated reviews.

Retrieve all reviews

A summarized information array of all available reviews in a particular Entity

URL Structure : /apps/{app-key}/reviews

Method : GET

Parameters :

Sample response :

 {"status": "successful",
  "results": [
  {
    "modelVersion": "",
    "reviewId": "",
    "version": "",
    "status": "",
    "deleted": "",
    "readyToProcess": "",
    "readyToView": "",
    "appKey": "",
    "appName": "",
    "createdUser": "",
    "displayName": "",
    "createdTime": "",
    "entityType": "",
    "entityId": "",
    "entityName": "",
    "comment": "",
    "title": "",
    "nps": 0,
    "parentReview": null,
    "childReviews": [],
    "numberData": [
        {
        "key": "",
        "value": ""
        }
    ],
    "textData": [],
    "imageData": [],
    "imageDets": [],
    "numberMeta": [],
    "textMeta": [],
    "suggestedReview": "",
    "mappedFormTemplateKey": "",
    "mappedViewTemplateKey": "",
    "replies": [],
    "sentiments": [],
    "scoredComment": [],
    "rawNumberData": {},
    "rawTextMeta": {},
    "rawNumberMeta": {},
    "rawScoredComment": {},
    "pvCount": 0,
    "nvCount": 0,
    "reviewerMeta": {
        "reviewerType": "",
        "appRole": "",
        "userLevel": 0,
        "additionalUserInfo": []
      },
    "reviewOrigin": ""
   }
    ],
    "pagination": {
    "totalCount": "",
    "totalPages": "",
    "currentPage": "",
    "perPage": ""
  }
}

Approve reviews

Changes the status to approve of a particular review.

URL Structure : /apps/{app-key}/reviews/approvals

Method : POST

Parameters :

Sample response :

{
   "status": "successful",
   "results": [[""]]
}

Retrieve review

Retrieve a particular review when the review ID is provided.

URL Structure : /apps/{app-key}/reviews/{review-id}

Method : GET

Parameters :

Sample response :

{
   "status": "successful",
   "results": [   {
    "modelVersion": "",
    "reviewId": "",
    "version": "",
    "status": "",
    "deleted": "",
    "readyToProcess": "",
    "readyToView": "",
    "appKey": "",
    "appName": "",
    "createdUser": "",
    "displayName": "",
    "createdTime": "",
    "entityType": "",
    "entityId": "",
    "entityName": "",
    "comment": "",
    "title": "",
    "nps": 0,
    "parentReview": null,
    "childReviews": [],
    "numberData": [
        {
        "key": "",
        "value": ""
        }
    ],
    "textData": [],
    "imageData": [],
    "imageDets": [],
    "numberMeta": [],
    "textMeta": [],
    "suggestedReview": "",
    "mappedFormTemplateKey": "",
    "mappedViewTemplateKey": "",
    "replies": [],
    "sentiments": [],
    "scoredComment": [],
    "rawNumberData": {},
    "rawTextMeta": {},
    "rawNumberMeta": {},
    "rawScoredComment": {},
    "pvCount": 0,
    "nvCount": 0,
    "reviewerMeta": {
        "reviewerType": "",
        "appRole": "",
        "userLevel": 0,
        "additionalUserInfo": []
      },
    "reviewOrigin": ""
   }
   ]
}

Moderate review

Moderate a particular review when the review-id is specified.

URL Structure : /apps/{app-key}/reviews/{review-id}

Method : PUT

Parameters :

Sample response :

{
   "status": "successful",
   "results": [{"message": ""}]
}

Reply a particular review

Replies a particular review when the review-id is provided.

URL Structure : /apps/{app-key}/reviews/{review-id}/replies

Method : POST

Parameters :

Sample response :

{
   "status": "successful",
   "results": [{"message": ""}]
}

Vote a review

Vote a particular review specifying the review-id

URL Structure : /apps/{app-key}/reviews/{review-id}/votes

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "reviewId": "",
      "vote": "",
      "createdUser": "",
      "displayName": "",
      "createdTime": "",
      "ip": "",
      "userAgent": ""
    }
  ]
}

Retrieve review replies

Retrieves all the replies given to a particular review when the review-id is specified.

URL Structure : /apps/{app-key}/reviews/{review-id}/replies

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "modelVersion": "",
      "appKey": "",
      "replyId": "",
      "reviewId": "",
      "content": "",
      "deleted": "",
      "createdUser": "",
      "displayName": "",
      "createdTime": "",
      "ip": "",
      "userAgent": ""
    }
  ]
}

Delete reply

Delete a reply given for a particular review.

URL Structure : /apps/{app-key}/reviews/{review-id}/replies/{reply-id}

Method : DELETE

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}

Delete a review

Delete a particular review when a review-id is provided.

URL Structure : /apps/{app-key}/reviews/{review-id}

Method : DELETE

Parameters :

Sample response :

{
   "status": "successful",
   "results": [{"message": ""}]
   }

Delete all reviews

Facilitates with the functionality to delete a selected bulk of reviews or delete all in a particular Entity.

URL Structure : /apps/{app-key}/reviews

Method : DELETE

Parameters :

This controller contains all features and functionalities that relates with ReviewSpotter analytics.

Retrieve email invitation statistics

Loads information of generated email invitations

URL Structure : /apps/{app-key}/analytics/invitation-stats

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "QR": {
        "notResponded": "",
        "expired": "",
        "notActive": "",
        "responded": ""
      },
      "RCD": {
        "notResponded": "",
        "expired": "",
        "notActive": "",
        "responded": ""
      },
      "EMAIL": {
        "notResponded": "",
        "expired": "",
        "notActive": "",
        "responded": ""
      },
      "DIRECT": {
        "notResponded": "",
        "expired": "",
        "notActive": "",
        "responded": ""
      },
      "URL": {
        "notResponded": "",
        "expired": "",
        "notActive": "",
        "responded": ""
      }
    }
  ]
}

Retrieve entity rankings

Loads review site rankings (basic or sentiment) of a given entity type

URL Structure : /apps/{app-key}/analytics/entities/rankings

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "entityId": "",
      "entityName": "",
      "score": "",
      "reviewCount": "",
      "rank": ""
    }
  ]
}

Retrieve review ratings

Gives the rating score of system derived review factors

URL Structure : /apps/{app-key}/analytics/reviews/ratings

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "key": "",
      "name": "",
      "rating": "",
      "reviewCount": "",
      "stats": {}
    }
  ]
}

Retrieve analyzed review data

This method will retrieve review analysis information per entity, once the entity-id is specified.

URL Structure : /apps/{app-key}/analytics/reviews

Method : GET

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "modelVersion": "",
            "reviewId": "",
            "status": "",
            "deleted": "",
            "readyToProcess": "",
            "appKey": "",
            "appName": "",
            "createdUser": "",
            "displayName": "",
            "createdTime": "",
            "entityType": "",
            "entityId": "",
            "entityName": "",
            "comment": "",
            "title": "",
			"parentReview": null,
			"childReviews": [],
            "numberData": [],
            "textData": [],
			"imageData": [],
            "numberMeta": [],
            "textMeta": [],
            "replies": [],
            "sentiments": [],
            "scoredComment": [],
            "rawNumberData": {
                "overall": ""
            },
            "rawTextMeta": {
                "ip": "",
                "source": "",
                "user-agent": ""
            },
            "rawNumberMeta": {},
            "rawScoredComment": {},
            "pvCount": "",
            "nvCount": "",
			 }
  ],
  "pagination": {
    "totalCount": 1,
    "totalPages": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

Retrieve review trends

Loads basic/sentiment trend values of system defined review factors

URL Structure : /apps/{app-key}/analytics/reviews/trends

Method : GET

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "location": [
                {
                    "fromDate": "",
                    "toDate": "",
                    "value": ""
                }
            ]
        },
        {
            "experience": [
                {
                    "fromDate": "",
                    "toDate": "",
                    "value": ""
                }
            ]
        }
    ]
}

Manage all features and functionalities combined with ReviewSpotter conversations.

Start conversation

Provide all options related with starting a new conversation.

URL Structure : /apps/{app-key}/conversations

Method : POST

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "id": "",
            "message": ""
        }
    ]
}

Retrieve all conversations

Loads all available conversations.

URL Structure : /apps/{app-key}/conversations

Method : GET

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "modelVersion": "",
            "conversationId": "",
            "title": "",
            "startedBy": "",
            "startedByDisplayName": "",
            "startedAt": "",
            "closedBy": "",
            "closedByDisplayName": "",
            "closedAt": "",
            "lastUpdatedAt": "",
            "status": "",
            "conversationType": "",
            "startedFromType": "",
            "priorityLevel": "",
            "markedAsIncident": "",
            "incidentStatus": "",
            "appKey": "",
            "entityType": "",
            "entityId": "",
            "groupKey": "",
            "limitedToShared": "",
            "sharedEmails": [],
            "deleted": ""
        }
    ]
}

Retrieve a conversation

Filters a specific conversation when the conversation ID is given.

URL Structure : /apps/{app-key}/conversations/{conversation-id}

Method : GET

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "modelVersion": "",
            "conversationId": "",
            "title": "",
            "startedBy": "",
            "startedByDisplayName": "",
            "startedAt": "",
            "closedBy": "",
            "closedByDisplayName": "",
            "closedAt": "",
            "lastUpdatedAt": "",
            "status": "",
            "conversationType": "",
            "startedFromType": "",
            "priorityLevel": "",
            "markedAsIncident": "",
            "incidentStatus": "",
            "appKey": "",
            "entityType": "",
            "entityId": "",
            "groupKey": "",
            "limitedToShared": "",
            "sharedEmails": [],
            "deleted": ""
        }
    ]
}

Add a conversation message

Add a new message to an existing conversation.

URL Structure : /apps/{app-key}/conversations/{conversation-id}/messages

Method : POST

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "id": "",
            "message": ""
        }
    ]
}

Retrieve all messages

Load all messages of a conversation when the conversation ID is given.

URL Structure : /apps/{app-key}/conversations/{conversation-id}/messages

Method : GET

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "modelVersion": "",
            "mbId": "",
            "parentId": "",
            "messageBubbleType": "",
            "messageBubbleStatus": "",
            "deleted": "",
            "user": "",
            "displayName": "",
            "createdTime": "",
            "message": "",
            "appKey": "",
            "files": []
        }
    ]
}

Retrieve a message

Loads a specific message of a conversation when the message ID is given.

URL Structure : /apps/{app-key}/conversations/{conversation-id}/messages/{message-id}

Method : GET

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "modelVersion": "",
            "mbId": "",
            "parentId": "",
            "messageBubbleType": "",
            "messageBubbleStatus": "",
            "deleted": "",
            "user": "",
            "displayName": "",
            "createdTime": "",
            "message": "",
            "appKey": "",
            "files": []
        }
    ]
}

Delete a conversation message

Deletes a specific message from a conversation when the message ID is specified

URL Structure : /apps/{app-key}/conversations/{conversation-id}/messages

Method : DELETE

Parameters :

Sample response :

								{
    "status": "successful",
    "results": [
        {
            "id": "",
            "message": ""
        }
    ]
}

Change incident status

Allows to change the status of an available conversation.

URL Structure : /apps/{app-key}/conversations/{conversation-id}/incident-status

Method : PUT

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "message": ""
        }
    ]
}

Change conversation settings

The method can be used to modify an existing conversation.

URL Structure : /apps/{app-key}/conversations/{conversation-id}/settings

Method : PUT

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "message": ""
        }
    ]
}

Change conversation status

Can be used to change the conversation status of an existing conversation.

URL Structure : /apps/{app-key}/conversations/{conversation-id}/status

Method : PUT

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "message": ""
        }
    ]
}

Delete conversation

Delets a specific conversation when the conversation ID is specified

URL Structure : /apps/{app-key}/conversations/{conversation-id}

Method : DELETE

Parameters :

Sample response :

{
    "status": "successful",
    "results": [
        {
            "message": ""
        }
    ]
}

This allows managing and creating invitation links in the application.

Create and retrieve short url

This creates short links for a particular application when the app key is specified.

URL Structure : /links

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "shortLink": "",
      "originalLink": ""
    }
  ]
}

Create and retrieve short link for review invite

This creates a short link for the review invitation form when the invitation key and app key is specified

URL Structure : /links/generate/review-invite

Method : POST

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      {
      "shortLink": "",
      "originalLink": ""
    }
    }
  ]
}

Retrieve link from short code

Retrieves the original link when the short link is given.

URL Structure : /links/{short-code}

Method : GET

Parameters :

Sample response :

{
  "status": "successful",
  "results": [
    {
      "message": ""
    }
  ]
}