https://api.movidesk.com/public/v1
Satisfaction Survey Questions
URL: /survey/questions Methods: GET
Layout
question
| Property | Type | Size | Required | Description |
|---|---|---|---|---|
| id | string | Read-only | ||
| languages | array | List of question languages. see documentation | ||
| isActive | bool | Whether the question is active or not | ||
| type | int | Survey type: Satisfied or Dissatisfied = 1, Smiley Faces = 2, NPS (Net Promoter Score) = 3, Yes or No = 4. |
Questions » Languages
question.languages[n]
| Property | Type | Size | Required | Description |
|---|---|---|---|---|
| cultureId | string | Language of the satisfaction survey | ||
| description | string | Question description |
*UTC: Coordinated Universal Time (from English Universal Time Coordinated) is the reference time zone from which all other time zones in the world are calculated. Ex: If your time zone is Brasília (UTC-03:00) and the current time is 15:30, the UTC time will be 18:30.
Working with data
To access the data, it is necessary to first generate an API key
To generate an API key (token), access Movidesk, go to Settings / Account / Parameters and in the environment tab click on the "Generate new key" button if you don't have one created yet.
You can repeat this operation whenever you need to generate a new access key, but remember that generating a new key will cause all programs using the old key to stop working.
All data flows (Visualization/Insertion/Modification) must be in JSON format as shown in the example below:
{
"id":"QWMv",
"languages":[
{
"cultureId":"pt-BR",
"description":"What is your evaluation for this service?"
},
{
"cultureId":"en-US",
"description":"What is your evaluation for this service?"
},
{
"cultureId":"es-ES",
"description":"¿Cuál es tu evaluación para este servicio?"
}
],
"isActive":true,
"type":3
}
Obtaining data
Method GET
Getting satisfaction survey questions
GET: /survey/questions
Parameter: token
Optional parameter: type
Example:
Getting the satisfaction survey questions.
GET: https://api.movidesk.com/public/v1/survey/questions?token=3bd53482-72b0-4057-9545-3975a3423ec5
Response:
[
{
"id":"QWMv",
"languages":[
{
"cultureId":"pt-BR",
"description":"What is your evaluation for this service?"
},
{
"cultureId":"en-US",
"description":"What is your evaluation for this service?"
},
{
"cultureId":"es-ES",
"description":"¿Cuál es tu evaluación para este servicio?"
}
],
"isActive":true,
"type":3
},
{
"id":"R3xq",
"languages":[
{
"cultureId":"pt-BR",
"description":"On a scale of 0 to 10, how likely is it that you would recommend us to a friend or colleague?"
},
{
"cultureId":"en-US",
"description":"On a scale of 0 to 10, how likely is it that you would recommend us to a friend or colleague?"
},
{
"cultureId":"es-ES",
"description":"On a scale of 0 to 10, how likely is it that you would recommend us to a friend or colleague?"
}
],
"isActive":true,
"type":3
}
]
Getting a single question
GET: /survey/questions/{question_id}
Parameters: token
Example:
Getting a satisfaction survey question by id.
GET: https://api.movidesk.com/public/v1/survey/questions/QWMv?token=3bd53482-72b0-4057-9545-3975a3423ec5
- To locate the survey ID, you should use the general query, this ID will be indicated in the URL of this request.
- Send through the "Headers" the Key "token" and the "Value" indicating your base token, as shown in the example below:
In this way, the response will be the data of the desired survey.
Response:
{
"id":"R3xq",
"languages":[
{
"cultureId":"pt-BR",
"description":"On a scale of 0 to 10, how likely is it that you would recommend us to a friend or colleague?"
},
{
"cultureId":"en-US",
"description":"On a scale of 0 to 10, how likely is it that you would recommend us to a friend or colleague?"
},
{
"cultureId":"es-ES",
"description":"On a scale of 0 to 10, how likely is it that you would recommend us to a friend or colleague?"
}
],
"isActive":true,
"type":3
}