Olá, como podemos ajudar você?

  1. Página inicial
  2. Voltar para a pesquisa
  3. 05 - Integrações
  4. API's
API do Movidesk - Pesquisa de satisfação - Respostas
20 min
Criado por Movidesk em 04/11/2019 14:26
Atualizado por Thiago Tamanini em 28/07/2022 11:42
Importante: Nossas API's possuem um limite de 10 requisições por minuto para garantir um comportamento saudável no seu uso. Caso você tenha um cenário específico que precise aumentar o uso, entre em contato com o nosso time de atendimento para análise de viabilidade. Saiba mais sobre horários e limites das API's
https://api.movidesk.com/public/v1

Respostas da pesquisa de satisfação

  URL:    /survey/responses
  Métodos: GET

Layout

response

Propriedade Tipo Tamanho Obrigatório Descrição
id string     Identificador da resposta da pesquisa de satisfação 
questionId string     Identificador da pergunta da pesquisa de satisfação.
clientId string     Id (Cod. ref.) da empresa, departamento ou pessoa relacionado como cliente da resposta.  
type int     Tipo da pesquisa: Satisfeito ou Insatisfeito = 1, Faces Sorridentes = 2, NPS (Net Promoter Score) = 3, Sim ou Não = 4.
ticketId int     Número do ticket
responseDate date UTC*     Data de resposta da pesquisa de satisfação.
commentary string MAX   Comentários da reposta.
value int     Pontuação da resposta com base no tipo. Satisfeito ou insatisfeito (1 = Satisfeito, 2 = Insatisfeito), Faces sorridentes (1 = Muito insatisfeito, 2 = Insatisfeito, 3 = Neutro, 4 = Satisfeito, 5 = Muito satisfeito), NPS (0 a 10), Sim ou não (1 = Sim, 2 = Não).

*UTC: O Tempo Universal Coordenado (do inglês Universal Time Coordinated) é o fuso horário de referência a partir do qual se calculam todas as outras zonas horárias do mundo. Ex: Se o seu fuso horário for o de Brasília (UTC-03:00) e o horário atual for 15h30, o horário UTC será 18h30.

Trabalhando com os dados

Para ter acesso aos dados é necessário que previamente seja gerada uma chave para a API

Para gerar uma chave para a API (token), acesse ao Movidesk, vá em Configurações / Conta / Parâmetros e na guia ambiente clique no botão "Gerar nova chave" caso ainda não tenha uma criada.
Você poderá repetir essa operação sempre que quiser gerar uma nova chave de acesso, mas lembre-se que ao gerar uma nova chave, todos os programas que utilizarem a chave antiga irão parar de funcionar.Todo o fluxo de dados (Visualização/Inserção/Alteração) devem possuir o formato JSON conforme exemplo abaixo:

{
    "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": "Muito bom",
       "value": 2
    }
 ]
}

Obtendo dados

Método GET

Obtendo respostas da pesquisa de satisfação com paginação :

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

Paramêtros:
limit Um limite no número de objetos a serem retornados, entre 1 e 100. (padrão: 100)
startingAfter Um cursor para uso na paginação. startingAfter é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação e receber 100 objetos, terminando com Xm5T, em sua chamada subsequente poderá ser incluida o parametro  startingAfter=Xm5T para buscar a próxima página. (opcional)
Retorno:
hasMore Se há ou não mais elementos disponíveis após este conjunto. Se false, compreende-se como o final da lista.
items Um array contendo as atividades da página atual.


Exemplo:

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": "Muito bom",
       "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
    }
 ]
}

Obtendo respostas da pesquisa de satisfação:

GET: /survey/responses
Parâmetros: token 
Parâmetro opcional: type, clientId, ticketId, responseDateGreaterThan, responseDateLessThan, limit, startingAfter

Exemplo:

Obtendo as respostas da pesquisa de satisfação.

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": "Muito bom",
       "value": 2
    }
 ]
}

 Obtendo respostas por cliente:

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

Exemplo:

Obtendo as respostas da pesquisa de satisfação 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": "Muito bom",
       "value": 2
    }
 ]
}

 

Obtendo respostas por tipo:

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

Exemplo:

Obtendo as respostas da pesquisa de satisfação 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": "Gostei do atendimento",
       "value": 7
    }
 ]
}

 

Obtendo respostas por data maior ou igual a:

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

Exemplo:

Obtendo as respostas da pesquisa de satisfação por data.  

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": "Muito bom",
       "value": 2
    }
 ]
}

 

Obtendo respostas por data menor ou igual a:

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

Exemplo:

Obtendo as respostas da pesquisa de satisfação por data.  

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": "Muito bom",
       "value": 2
    }
 ]
}

 

Obtendo respostas por número ou protocolo do ticket:

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

Exemplo:

Obtendo as respostas da pesquisa de satisfação por número ou protocolo do ticket.  

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

Retorno:

{
    "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": "Muito bom",
       "value": 2
    }
 ]
}

 

Obtendo dados

Método GET

Obtendo um único serviço

Obtendo dados

Método GET

Obtendo um único serviço

Obtendo dados

Método GET

Obtendo um único serviço

Obtendo dados

Método GET

Obtendo um único serviço

Obtendo dados

Método GET

Obtendo um único serviço

Obtendo dados

Método GET

Obtendo um único serviço

Obtendo dados

Método GET

Obtendo um único serviço

Obtendo dados

Método GET

Obtendo um único serviço

{
"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": "Muito bom",
"value": 2
}
]
}
Este artigo foi útil para você?
Últimos artigos visitados