Relesys API Docs

v1.3

https://api.relesysapp.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests Permissions Notifications Markdown Syntax Module Settings

Endpoints

Sentiments

List
GET /surveymodules/{moduleId}/surveys/{surveyId}/instances/{instanceId}/sentiments 
https://api.relesysapp.net/api/v1.3/surveymodules/{moduleId}/surveys/{surveyId}/instances/{instanceId}/sentiments
Get a list of sentiments for open-ended answers for survey instance with instanceId in the survey with surveyId, within the module moduleId. Sentiment types:
  • Positive
  • Neutral
  • Negative
  • Mixed
Default sorting is by creationDateTime in ascending order.

Please note: Tracking Survey feature must be enabled for the account, Sentiment Analysis must be enabled for the module, and questions should be configured for Sentiment Analysis. If no questions are configured, the endpoint will return an empty response. Otherwise status code 400 - Bad Request will be returned.
Scopes: relesys.api, relesys.api:read, relesys.api.survey, relesys.api.survey:read
URL Path
moduleId string / guid The module's unique identifier required
surveyId string / guid The survey's unique identifier required
instanceId string / guid The survey instance's unique identifier required
Query String
answerId string / guid Filterable optional
answerText string Filterable Sortable optional
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
questionId string / guid Filterable optional
sentimentType string Filterable Sortable optional
userId string / guid Filterable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200
Schema Example
JSON
{"count":2,"data":[{"id":"0d64f9a3-cb16-4225-9ecd-c1539d24cfee","userId":"5f455fc3-b962-41aa-bb29-43396486d22b","questionId":"0ae95eaa-5751-437a-8130-9ae9297b7f96","answerId":"dc317414-bd66-46e6-bf82-b0cdf37f11ba","sentimentType":"Positive","answerText":"Great service and friendly staff!","creationDateTime":"2025-10-09T03:15:09.8623812+00:00","lastModifiedDateTime":"2025-10-15T03:15:09.8623812+00:00"},{"id":"ba688375-6fb4-424d-9377-5f72a5f0199a","userId":"94e516ed-d2a7-4182-a639-bbc0fa3c2247","questionId":"05787c8f-e67a-43e5-bc8f-22757372da09","answerId":"0b18901a-9233-45d1-8dde-47cb688e8a09","sentimentType":"Negative","answerText":"Bad service!","creationDateTime":"2025-10-14T03:15:09.8623812+00:00","lastModifiedDateTime":null}]}
object
  count integer      
  ⯈ data array[object]      
   answerId string / guid      
   answerText string      
   creationDateTime datetimeoffset      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   questionId string / guid      
   sentimentType string      
   userId string / guid      
  nextUrl string      
  previousUrl string