Listar Respostas
Retorna uma lista paginada com as respostas das pesquisas de determinada unidade.
curl -X POST "https://api.amplifique.me/partners/cf/answers?limit=42&page=25&start=01/01/2024&end=31/12/2024&include_survey=true&only_finalized=example_string&survey=example_string" \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_API_KEY"
import requests
import json
url = "https://api.amplifique.me/partners/cf/answers?limit=42&page=25&start=01/01/2024&end=31/12/2024&include_survey=true&only_finalized=example_string&survey=example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "YOUR_API_KEY"
}
response = requests.post(url, headers=headers)
print(response.json())
const response = await fetch("https://api.amplifique.me/partners/cf/answers?limit=42&page=25&start=01/01/2024&end=31/12/2024&include_survey=true&only_finalized=example_string&survey=example_string", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("POST", "https://api.amplifique.me/partners/cf/answers?limit=42&page=25&start=01/01/2024&end=31/12/2024&include_survey=true&only_finalized=example_string&survey=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.amplifique.me/partners/cf/answers?limit=42&page=25&start=01/01/2024&end=31/12/2024&include_survey=true&only_finalized=example_string&survey=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"data": [
{
"_id": "645e95240c1647609077969b",
"_survey": "60afce1ca9680b000eca2459",
"channel": 4,
"answered": true,
"opened": true,
"opened_at": "2023-05-12T19:36:04.367Z",
"finalized": true,
"deleted": false,
"origin": "preview.amplifique.me/preview/60afce1ca9680b000eca2459?version=2",
"anonymized": false,
"resolved": false,
"attempts": 1,
"_customer": "645e95240c16476090779698",
"_business": "5b5765bec9498b0014883c0b",
"answers": [
{
"internal_name": "nps_1",
"answer": 10,
"isMainMetric": true,
"type": "nps",
"_id": "645e9557fdfa5a0ffd07289e"
}
],
"created_at": "2023-05-12T19:36:04.368Z",
"notes": [
{}
],
"answered_at": "2023-05-12T19:36:55.614Z",
"originIp": "2a09:bac1:1120:19d8::61:205",
"time_to_answer": 50.757,
"finalized_at": "2023-05-12T19:36:55.625Z",
"score": 100,
"customer": {
"name": "João da Silva",
"email": "joao@example.com",
"tel": "+5542999999999",
"custom_fields": {}
},
"custom_fields": {},
"deleted_by": {}
}
],
"total": 123,
"pages": 10,
"page": 0
}
/partners/cf/answers
API key (sent in header)
Limite de respostas retornadas por página. Mín: 1, Máx: 1000
Número da página a retornar. Mín: 0
Data inicial do filtro (formato dd/MM/yyyy). Requer o parâmetro end.
Data final do filtro (formato dd/MM/yyyy). Requer o parâmetro start.
Quando true, retorna a estrutura completa da pesquisa junto de cada resposta.
Filtra por status de finalização. Valores aceitos: complete, incomplete, all.
Filtra resultados de uma pesquisa específica. Informar o ID da pesquisa (ex: 67f578cccc4ab22df8543fcc).
The media type of the request body
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. Provide your API key in the header.
Query Parameters
Limite de respostas retornadas por página. Mín: 1, Máx: 1000
Número da página a retornar. Mín: 0
Data inicial do filtro (formato dd/MM/yyyy). Requer o parâmetro end.
Data final do filtro (formato dd/MM/yyyy). Requer o parâmetro start.
Quando true, retorna a estrutura completa da pesquisa junto de cada resposta.
Filtra por status de finalização. Valores aceitos: complete, incomplete, all.
Filtra resultados de uma pesquisa específica. Informar o ID da pesquisa (ex: 67f578cccc4ab22df8543fcc).
Responses
ID da resposta/solicitação
ID da pesquisa
Canal de envio: 0→SMS, 1→EMAIL, 2→WHATSAPP, 3→LINK, 4→INAPP, 6→WhatsApp API
Se a pesquisa foi respondida
Se a pesquisa foi aberta pelo cliente
Data/hora em que foi aberta
Se a pesquisa foi finalizada (todas as perguntas respondidas)
Se a resposta está na lixeira
Origem da resposta (Link ou InApp)
Se a resposta foi anonimizada
Se a resposta foi marcada como resolvida
Número de tentativas de envio (SmartFollowUp)
ID do contato
ID da unidade
Lista com todas as respostas das perguntas
Identificador interno da pergunta
Resposta da pergunta. O tipo varia conforme o tipo da pergunta: número para nps/csat/ces/likert, string para text/unique/select/thumbs ('up' ou 'down'), array de strings para multiple, objeto (chave: valor) para matrix.
Se é a pergunta principal (1ª pergunta da pesquisa)
Tipo da pergunta
npscsatcesthumbsuniquemultipleselecttextlikertmatrixID da resposta da pergunta
Data de criação da solicitação
Anotações internas vinculadas à resposta
Data/hora em que a pesquisa foi respondida
IP de origem da resposta
Tempo em segundos que o cliente levou para responder
Data/hora de finalização
AmpliScore da resposta (0–100)
Dados do contato que respondeu
Campos customizados do contato
Campos customizados da resposta
Dados do usuário que enviou a resposta para a lixeira
Total de registros encontrados
Total de páginas disponíveis
Página atual retornada