Hola, ¿cómo podemos ayudarte?

  1. Consola principal
  2. Volver a la búsqueda
  3. 05. Integraciones
  4. API's
API de Movidesk - Encuesta de satisfacción - Respuestas
21 min
Creado por Movidesk en 04/11/2019 14:26
Actualizado por Karine Moreira en 24/09/2024 16:30
Importante: Nuestras APIs tienen un límite de 10 solicitudes por minuto para garantizar un uso saludable. Si tienes un escenario específico que requiere aumentar el uso, contacta a nuestro equipo de atención para un análisis de viabilidad. Más información sobre horarios y límites de las APIs
https://api.movidesk.com/public/v1

Respuestas de la encuesta de satisfacción

  URL:    /survey/responses
  Métodos: GET

Layout

response

Propiedad Tipo Tamaño Obligatorio Descripción
id string     Identificador de la respuesta de la encuesta de satisfacción (Solo lectura).
questionId string     Identificador de la pregunta de la encuesta de satisfacción. (Solo lectura).
clientId string     Id (Cod. ref.) de la empresa, departamento o persona relacionada como cliente de la respuesta.
type int     Tipo de encuesta: Satisfecho o Insatisfecho = 1, Caritas Sonrientes = 2, NPS (Net Promoter Score) = 3, Sí o No = 4.
ticketId int     Número del ticket
responseDate date UTC*     Fecha de la respuesta de la encuesta de satisfacción.
commentary string MAX   Comentarios de la respuesta.
value int     Puntuación de la respuesta según el tipo. Satisfecho o insatisfecho (1 = Satisfecho, 2 = Insatisfecho), Caritas sonrientes (1 = Muy insatisfecho, 2 = Insatisfecho, 3 = Neutro, 4 = Satisfecho, 5 = Muy satisfecho), NPS (0 a 10), Sí o no (1 = Sí, 2 = No).

*UTC: El Tiempo Universal Coordinado (del inglés Universal Time Coordinated) es el huso horario de referencia a partir del cual se calculan todas las demás zonas horarias del mundo. Ej: Si tu huso horario es el de Brasilia (UTC-03:00) y la hora actual es 15:30, la hora UTC será 18:30.

Trabajando con los datos

Para acceder a los datos es necesario que previamente se genere una clave para la API.

Para generar una clave para la API (token), accede a Movidesk, ve a Configuraciones / Cuenta / Parámetros y en la pestaña de entorno haz clic en el botón "Generar nueva clave" si aún no tienes una creada.
Podrás repetir esta operación siempre que quieras generar una nueva clave de acceso, pero recuerda que al generar una nueva clave, todos los programas que utilicen la clave antigua dejarán de funcionar.Todo el flujo de datos (Visualización/Inserción/Modificación) debe tener el formato JSON como el ejemplo a continuación:

{
    "hasMore": false,
    "items": [
    {
       "id": "l6Bz",
       "questionId": "pZN7",
       "type": 1,
       "clientId": "123456",
       "ticketId": 8694,
       "responseDate": "2019-10-30T13:35:38.0174433",
       "commentary": null,
       "value": 1
    },
    {
       "id": "2PLQ",
       "questionId": "pBzd",
       "type": 1,
       "clientId": "456123",
       "ticketId": 6489,
       "responseDate": "2019-10-30T13:36:11.5603728",
       "commentary": "Muy bueno",
       "value": 2
    }
 ]
}

Obtención de datos

Método GET

Obteniendo respuestas de la encuesta de satisfacción con paginación:

GET: /survey/responses
Parámetros: token 
Parámetro opcional: limit, startingAfter

Parámetros:
limit Un límite en el número de objetos a devolver, entre 1 y 100. (predeterminado: 100)
startingAfter Un cursor para usar en la paginación. startingAfter es un ID de objeto que define su lugar en la lista. Por ejemplo, si haces una solicitud y recibes 100 objetos, terminando con Xm5T, en tu llamada subsiguiente podrás incluir el parámetro startingAfter=Xm5T para buscar la siguiente página. (opcional)
Retorno:
hasMore Si hay más elementos disponibles después de este conjunto. Si false, se entiende como el final de la lista.
items Un array que contiene las actividades de la página actual.


Ejemplo:

GET: https://api.movidesk.com/public/v1/survey/responses?token=3bd53482-72b0-4057-9545-3975a3423ec5&limit=2

Retorno:

{
    "hasMore": true,
    "items": [
    {
       "id": "l6Bz",
       "questionId": "pZN7",
       "type": 1,
       "clientId": "123456",
       "ticketId": 8694,
       "responseDate": "2019-10-30T13:35:38.0174433",
       "commentary": null,
       "value": 1
    },
    {
       "id": "2PLQ",
       "questionId": "pBzd",
       "type": 1,
       "clientId": "456123",
       "ticketId": 6489,
       "responseDate": "2019-10-30T13:36:11.5603728",
       "commentary": "Muy bueno",
       "value": 2
    }
 ]
}

GET: https://api.movidesk.com/public/v1/survey/responses?token=3bd53482-72b0-4057-9545-3975a3423ec5&limit=2&startingAfter=2PLQ

Retorno:

{
    "hasMore": true,
    "items": [
    {
       "id": "Pwlq",
       "questionId": "VzzG",
       "type": 3,
       "clientId": "245136",
       "ticketId": 8695,
       "responseDate": "2019-10-10T21:03:44.4786374",
       "commentary": "¡Excelente!",
       "value": 10
    },
    {
       "id": "2PLQ",
       "questionId": "pBzd",
       "type": 2,
       "clientId": "631583",
       "ticketId": 6490,
       "responseDate": "2019-10-10T21:02:51.3224777",
       "commentary": null,
       "value": 2
    }
 ]
}

Obteniendo respuestas de la encuesta de satisfacción:

GET: /survey/responses
Parámetros: token 
Parámetros disponibles: type, clientId, ticketId, responseDateGreaterThan, responseDateLessThan, limit, startingAfter

Ejemplo:

Obteniendo las respuestas de la encuesta de satisfacción.

GET: https://api.movidesk.com/public/v1/survey/responses?token=3bd53482-72b0-4057-9545-3975a3423ec5

Retorno:

{
    "hasMore": false,
    "items": [
    {
       "id": "l6Bz",
       "questionId": "pZN7",
       "type": 1,
       "clientId": "123456",
       "ticketId": 8694,
       "responseDate": "2019-10-30T13:35:38.0174433",
       "commentary": null,
       "value": 1
    },
    {
       "id": "2PLQ",
       "questionId": "pBzd",
       "type": 1,
       "clientId": "456123",
       "ticketId": 6489,
       "responseDate": "2019-10-30T13:36:11.5603728",
       "commentary": "Muy bueno",
       "value": 2
    }
 ]
}

 Obteniendo respuestas por cliente:

GET: /survey/responses
Parámetros: token, clientId

Ejemplo:

Obteniendo las respuestas de la encuesta de satisfacción por cliente.

GET: https://api.movidesk.com/public/v1/survey/responses?token=3bd53482-72b0-4057-9545-3975a3423ec&clientId=14498

Retorno:

{
    "hasMore": false,
    "items": [
    {
       "id": "l6Bz",
       "questionId": "pZN7",
       "type": 1,
       "clientId": "14498",
       "ticketId": 129,
       "responseDate": "2019-10-30T13:35:38.0174433",
       "commentary": null,
       "value": 1
    },
    {
       "id": "2PLQ",
       "questionId": "pBzd",
       "type": 1,
       "clientId": "14498",
       "ticketId": 125,
       "responseDate": "2019-10-30T13:36:11.5603728",
       "commentary": "Muy bueno",
       "value": 2
    }
 ]
}

 

Obteniendo respuestas por tipo:

GET: /survey/responses
Parámetros: token, type

Ejemplo:

Obteniendo las respuestas de la encuesta de satisfacción por tipo.

GET: https://api.movidesk.com/public/v1/survey/responses?token=3bd53482-72b0-4057-9545-3975a3423ec5&type=3

Retorno:

{
    "hasMore": false,
    "items": [
    {
       "id": "l6Bz",
       "questionId": "pZN7",
       "type": 3,
       "clientId": "123456",
       "ticketId": 8694,
       "responseDate": "2019-10-30T13:35:38.0174433",
       "commentary": null,
       "value": 10
    },
    {
       "id": "2PLQ",
       "questionId": "pBzd",
       "type": 3,
       "clientId": "456123",
       "ticketId": 6489,
       "responseDate": "2019-10-30T13:36:11.5603728",
       "commentary": "Me gustó la atención",
       "value": 7
    }
 ]
}

 

Obteniendo respuestas por fecha mayor o igual a:

GET: /survey/responses
Parámetros: token, responseDateGreaterThan

Ejemplo:

Obteniendo las respuestas de la encuesta de satisfacción por fecha.  

GET: https://api.movidesk.com/public/v1/survey/responses?token=3bd53482-72b0-4057-9545-3975a3423ec5&responseDateGreaterThan=2019-05-13

Retorno:

{
    "hasMore": false,
    "items": [
    {
       "id": "l6Bz",
       "questionId": "pZN7",
       "type": 1,
       "clientId": "123456",
       "ticketId": 8694,
       "responseDate": "2019-10-30T13:35:38.0174433",
       "commentary": null,
       "value": 1
    },
    {
       "id": "2PLQ",
       "questionId": "pBzd",
       "type": 1,
       "clientId": "456123",
       "ticketId": 6489,
       "responseDate": "2019-10-30T13:36:11.5603728",
       "commentary": "Muy bueno",
       "value": 2
    }
 ]
}

 

Obteniendo respostas por data menor ou igual a:

GET: /survey/responses
Parámetros: token, responseDateLessThan

Ejemplo:

Obteniendo las respuestas de la encuesta de satisfacción por fecha.  

GET: https://api.movidesk.com/public/v1/survey/responses?token=3bd53482-72b0-4057-9545-3975a3423ec5&responseDateLessThan=2019-06-13

Retorno:

{
    "hasMore": false,
    "items": [
    {
       "id": "l6Bz",
       "questionId": "pZN7",
       "type": 1,
       "clientId": "123456",
       "ticketId": 8694,
       "responseDate": "2019-08-06T18:57:39.6348229",
       "commentary": null,
       "value": 1
    },
    {
       "id": "2PLQ",
       "questionId": "pBzd",
       "type": 1,
       "clientId": "456123",
       "ticketId": 6489,
       "responseDate": "2019-07-16T19:17:24.4060556",
       "commentary": "Muy bueno",
       "value": 2
    }
 ]
}

 

Obteniendo respuestas por número o protocolo del ticket:

GET: /survey/responses
Parámetros: token, ticketId

Ejemplo:

Obteniendo las respuestas de la encuesta de satisfacción por número o protocolo del ticket.  

GET: https://api.movidesk.com/public/v1/survey/responses?token=3bd53482-72b0-4057-9545-3975a3423ec5&ticketId=8694

Respuesta:

{
    "hasMore": false,
    "items": [
    {
       "id": "2PLQ",
       "questionId": "pZN7",
       "type": 1,
       "clientId": "123456",
       "ticketId": 8694,
       "responseDate": "2019-08-06T18:57:39.6348229",
       "commentary": null,
       "value": 1
    },
    {
       "id": "l6Bz",
       "questionId": "pBzd",
       "type": 1,
       "clientId": "42145",
       "ticketId": 8694,
       "responseDate": "2019-07-16T19:17:24.4060556",
       "commentary": "Muy bueno",
       "value": 2
    }
 ]
}

 

Obteniendo datos

Método GET

Obteniendo un único servicio

Obteniendo datos

Método GET

Obteniendo un único servicio

Obteniendo datos

Método GET

Obteniendo un único servicio

Obteniendo datos

Método GET

Obteniendo un único servicio

Obteniendo datos

Método GET

Obteniendo un único servicio

Obteniendo datos

Método GET

Obteniendo un único servicio

Obteniendo datos

Método GET

Obteniendo un único servicio

Obteniendo datos

Método GET

Obteniendo un único servicio

{
"hasMore": false,
"items": [
{
"id": "l6Bz",
"questionId": "pZN7",
"type": 1,
"clientId": "123456",
"ticketId": 8694,
"responseDate": "2019-10-30T13:35:38.0174433",
"commentary": null,
"value": 1
},
{
"id": "2PLQ",
"questionId": "pBzd",
"type": 1,
"clientId": "456123",
"ticketId": 6489,
"responseDate": "2019-10-30T13:36:11.5603728",
"commentary": "Muy bueno",
"value": 2
}
]
}
¿Te ha útil este artículo?
Vistos recientemente