Pesquisas e RespostasListar Respostas

Listar Respostas

Esse endpoint retornará uma lista com as respostas das pesquisas de determinada unidade.

curl -X POST "https://api.amplifique.me/partners/cf/answers?limit=42&page=25&start=2024-12-25&end=2024-12-25&include_survey=true&only_finalized=example_string&survey=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
"{
  "data": [
    {
      "_id": "645e95240c1647609077969b", //String | ID da Resposta/Solicitação
      "_survey": "60afce1ca9680b000eca2459", //String |ID da Pesquisa
      "channel": 4,  //Integer | Canal de envio 0-> SMS, 1->EMAIL, 2-> WHATSAPP, 3-> LINK, 4-> INAPP, 6-> WhatsApp API
      "answered": true, //Boolean | se a pesquisa foi respondida
      "opened": true, //Boolean | se a pesquisa foi aberta
      "opened_at": "2023-05-12T19:36:04.367Z", //Date | Quando foi aberta
      "finalized": true, //Boolean | se a pesquisa foi finalizada
      "deleted": false, //Boolean | se a resposta está na lixeira.
      "origin": "preview.amplifique.me/preview/60afce1ca9680b000eca2459?version=2", //String | Origem Link ou InApp apenas
      "anonymized": false, //Boolean | se a resposta foi anonimizada.
      "resolved": false, //Boolean | se a resposta foi marcada como resolvida.
      "attempts": 1, //Integer | Número de tentativas de envio (SmartFollowUp)
      "_customer": "645e95240c16476090779698", //String | ID do contato
      "_business": "5b5765bec9498b0014883c0b", //String | ID da unidade
      "answers": [
        //Array | Lista com todas as respostas das perguntas.
        {
          "internal_name": "nps_1", //String | Identificador Interno da Pergunta/resposta
          "answer": 10, //Any | Resposta (o tipo do dado pode variar conforme o tipo da pergunta)
          "isMainMetric": true, //Boolean | Se é a métrica principal (1º pergunta)
          "type": "nps", //String | Tipo da Pergunta/Resposta (nps,csat,ces,thumbs,unique,multiple,matrix,likert,select,text)
          "_id": "645e9557fdfa5a0ffd07289e" //String | ID da resposta da pergunta
        },
        {
          "internal_name": "csat_atendimento",
          "answer": 4,
          "isMainMetric": false,
          "type": "csat",
          "_id": "645e9557fdfa5a0ffd0728a0"
        },
        {
          "internal_name": "ces_adicionar_usuario",
          "answer": 7,
          "isMainMetric": false,
          "type": "ces",
          "_id": "645e9557fdfa5a0ffd0728a3"
        },
        {
          "internal_name": "text_4",
          "answer": "Gostei muito do atendimento",
          "isMainMetric": false,
          "type": "text",
          "_id": "645e9557fdfa5a0ffd0728a1"
        },
        {
          "internal_name": "thumbs_teste",
          "answer": "up", // String para thumbs pode ser up ou down
          "isMainMetric": false,
          "type": "thumbs",
          "_id": "645e9557fdfa5a0ffd0728a2"
        },
        {
          "internal_name": "Teste",
          "answer": 10,
          "isMainMetric": false,
          "type": "likert",
          "_id": "645e9557fdfa5a0ffd0728a3"
        },
        {
          "internal_name": "multiple_elogios",
          "answer": ["agilidade", "qualidade da solução"],
          "isMainMetric": false,
          "type": "multiple",
          "_id": "645e9557fdfa5a0ffd0728a3"
        },
        {
          "internal_name": "unique_ponto_positivo",
          "answer": "agilidade",
          "isMainMetric": false,
          "type": "unique",
          "_id": "645e9557fdfa5a0ffd0728a3"
        },
        {
          "internal_name": "select_negativo",
          "answer": "erros",
          "isMainMetric": false,
          "type": "select",
          "_id": "645e9557fdfa5a0ffd0728a3"
        },
        {
          "internal_name": "matriz_geral",
          "answer": {
          \t"atendimento":"Bom",
            "solucao":"Regular"
          },
          "isMainMetric": false,
          "type": "matrix",
          "_id": "645e9557fdfa5a0ffd0728a3"
        }
      ],
      "created_at": "2023-05-12T19:36:04.368Z", //Date | Data de criação da Solicitação
      "notes": [], //Array |
      "answered_at": "2023-05-12T19:36:55.614Z", //Date | Data de resposta
      "originIp": "2a09:bac1:1120:19d8::61:205", //String | IP de origem da resposta
      "time_to_answer": 50.757, //Float | Tempo de duração da pesquisa.
      "finalized_at": "2023-05-12T19:36:55.625Z", //Date | Data de finalização
      "score": 100, //Float | AmpliScore
      "customer": {
        //Object | Objeto com os dados do Contato
        "name": "Dallas Ritchie (Teste Preview In App)", //String | Nome do contato
        "email": "dallas_ritchie67@preview.amplifique.me", //String | E-mail do contato
        "tel": "+559xxxxxxxx", //String | Telefone do contato
        "custom_fields": {
          //Object | Contém os campos customizados do contato
        }
      },
      "custom_fields": {
        //Object | Contém os campos customizados da resposta
      },
      "deleted_by": {} //Object | Dados do Usuário que inseriu a resposta na lixeira.
    }
  ],
  "total": 123, //Total de registros
  "pages": 10, //Total de páginas
\t"page": 2 //Página atual
}
"
POST
/partners/cf/answers
POST
API Key (header: Authorization)
Authorizationstring
Required

API key (sent in header)

query
limitinteger

Limite de quantidade de respostas a ser retornado na API. Mín: 1 Max: 1000

Format: int32
query
pageinteger

Página a ser retornada da API. Mín: 0

Format: int32
query
startstring

A partir de determinada Data. Necessita do parâmetro end para funcionar

Format: date
query
endstring

Até determinada Data. Necessita do parâmetro start para funcionar

Format: date
query
include_surveyboolean

Retornar estrutura da pesquisa junto da resposta

query
only_finalizedstring

Retornar apenas respostas completas, incompletas ou todas.(complete, incomplete, all)

query
surveystring

Filtro para retornar resultados de apenas uma pesquisa (informar o ID, exemplo: 67f578cccc4ab22df8543fcc)

Content-Typestring
Required

The media type of the request body

Options:
No request body parameters defined
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

API Key for authentication. Provide your API key in the header.

Query Parameters

limitinteger

Limite de quantidade de respostas a ser retornado na API. Mín: 1 Max: 1000

pageinteger

Página a ser retornada da API. Mín: 0

startstring

A partir de determinada Data. Necessita do parâmetro end para funcionar

endstring

Até determinada Data. Necessita do parâmetro start para funcionar

include_surveyboolean

Retornar estrutura da pesquisa junto da resposta

only_finalizedstring

Retornar apenas respostas completas, incompletas ou todas.(complete, incomplete, all)

surveystring

Filtro para retornar resultados de apenas uma pesquisa (informar o ID, exemplo: 67f578cccc4ab22df8543fcc)

Responses

dataarray
totalinteger
pagesinteger
pageinteger