API do Movidesk - Pesquisa de satisfação - Perguntas
11 min
Criado por Movidesk em 04/11/2019 14:26
Atualizado por Alyne Regina Ruggiero Fanfa em 17/10/2022 15:51
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

 

Perguntas da pesquisa de satisfação

  URL:    /survey/questions
  Métodos: GET

Layout

question

Propriedade Tipo Tamanho Obrigatório Descrição
id string     Somente leitura 
languages array     Lista com os idiomas da pergunta. ver documentação
isActive bool     Se a pergunta está ou não ativa
type int     Tipo da pesquisa: Satisfeito ou Insatisfeito = 1, Faces Sorridentes = 2, NPS (Net Promoter Score) = 3, Sim ou Não = 4.

Perguntas » Idiomas

question.languages[n]

Propriedade Tipo Tamanho Obrigatório Descrição
cultureId string     Idioma da pesquisa de satisfação
description string     Descrição da pergunta

 

*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:

{
"id":"QWMv",
"languages":[
{
"cultureId":"pt-BR",
"description":"Qual sua avaliação para esse atendimento?"
},
{
"cultureId":"en-US",
"description":"What is your evaluation for this service?"
},
{
"cultureId":"es-ES",
"description":" ¿Qual su avaliación para este atendimiento?"
}
],
"isActive":true,
"type":3
}

Obtendo dados

Método GET

Obtendo perguntas da pesquisa de satisfação

GET: /survey/questions
Parâmetros: token 
Parâmetro opcional: type

Exemplo:

Obtendo as perguntas da pesquisa de satisfação.

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

Retorno:

[
{
"id":"QWMv",
"languages":[
{
"cultureId":"pt-BR",
"description":"Qual sua avaliação para esse atendimento?"
},
{
"cultureId":"en-US",
"description":"What is your evaluation for this service?"
},
{
"cultureId":"es-ES",
"description":" ¿Qual su avaliación para este atendimiento?"
}
],
"isActive":true,
"type":3
},
{
"id":"R3xq",
"languages":[
{
"cultureId":"pt-BR",
"description":"Em uma escala de 0 a 10, qual é a probabilidade de você nos recomendar para um amigo ou colega?"
},
{
"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":"¿En una escala de 0 a 10, qual es la probabilidad de recomendarnos para un amigo o colega?"
}
],
"isActive":true,
"type":3
}
]

 

Obtendo uma única pergunta

GET: /survey/questions/{question_id}
Parâmetros: token


Exemplo:

Obtendo uma pergunta da pesquisa de satisfação pelo id.

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

  • Para localizar o ID da pesquisa, deve ser utilizada a consulta geral, este id será indicado na URL desta requisição.
  • Enviar através do "Headers" a Key "token" e o "Value" indicando o token da sua base, conforme exemplo abaixo:

Obtendo um único serviço

Dessa forma o retorno serão os dados da pesquisa desejada.

Retorno:

{
"id":"R3xq",
"languages":[
{
"cultureId":"pt-BR",
"description":"Em uma escala de 0 a 10, qual é a probabilidade de você nos recomendar para um amigo ou colega?"
},
{
"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":"¿En una escala de 0 a 10, qual es la probabilidad de recomendarnos para un amigo o colega?"
}
],
"isActive":true,
"type":3
}

  

Este artigo foi útil para você?
Últimos artigos visitados