Como integrar dados da Amplifique.me com um BI?

Visão geral

Existem duas formas de integrar os dados de respostas da Amplifique.me com um sistema externo, como um BI (Business Intelligence). A escolha depende de como você quer receber as informações: de forma automática e em tempo real (Webhook) ou de forma programada e sob demanda (API).

Webhook — Receber respostas em tempo real

No modelo de webhook, a Amplifique.me envia ativamente os dados para o seu sistema sempre que uma nova resposta for registrada. Você não precisa fazer nenhuma consulta — basta ter um endpoint no seu servidor preparado para receber e processar o payload.

Como funciona:

1. Você cria um endpoint no seu servidor que aceita requisições POST
2. Registra a URL desse endpoint nas configurações de Webhook da Amplifique.me
3. A partir daí, toda vez que uma pesquisa for respondida, a plataforma envia automaticamente os dados para o seu endpoint
4. Seu sistema recebe, processa e salva as respostas no banco do BI

Quando usar:

• Você quer os dados no BI imediatamente após cada resposta
• Seu sistema consegue manter um endpoint sempre disponível para receber requisições

Payload recebido no seu endpoint:

{
  "event": {
    "event_type": "cf_response",
    "customer": {
      "name": "Nome do Respondente",
      "email": "email@respondente.com",
      "phone": "+5542999999999"
    },
    "cf_response": {
      "_id": "AAAAAAAAAAAAAAAAAAAAAA",
      "_survey": "AAAAAAAAAAAAAAAAAAAAAA",
      "channel": "E-mail",
      "finalized_at": "2024-01-15T14:30:00.000Z",
      "responses": [
        {
          "internal_name": "nps_1",
          "type": "nps",
          "answer": "9"
        }
      ]
    }
  }
}

Consulte a documentação completa do payload em Webhook: Nova Resposta.

API — Buscar respostas periodicamente

No modelo de API, o seu sistema faz consultas periódicas à Amplifique.me para buscar as respostas de um determinado período. Você agenda essa consulta (por exemplo, diariamente ou a cada hora) e salva os dados retornados no banco do BI.

Como funciona:

1. Você agenda uma rotina no seu sistema (ex: todo dia à meia-noite)
2. A rotina chama o endpoint Listar Respostas passando o intervalo de datas desejado
3. A API retorna todas as respostas daquele período
4. Seu sistema salva os dados no banco do BI

Quando usar:

• Você prefere processar os dados em lote em horários específicos
• Seu sistema não consegue manter um endpoint receptor disponível 24h
• Você precisa fazer uma importação histórica de um período passado

Exemplo de requisição — respostas de um dia específico:

curl -X POST "https://api.amplifique.me/partners/cf/answers?start=15/01/2024&end=15/01/2024&only_finalized=complete&limit=1000&page=0" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"

Exemplo de resposta:

{
  "data": [
    {
      "_id": "645e95240c1647609077969b",
      "_survey": "60afce1ca9680b000eca2459",
      "channel": 1,
      "finalized": true,
      "finalized_at": "2024-01-15T19:36:55.625Z",
      "answers": [
        { "internal_name": "nps_1", "type": "nps", "answer": 10 }
      ],
      "customer": {
        "name": "João da Silva",
        "email": "joao@example.com"
      }
    }
  ],
  "total": 123,
  "pages": 1,
  "page": 0
}

Consulte a documentação completa dos parâmetros em Listar Respostas.

Comparativo entre as abordagens

Perguntas frequentes

Documentação relacionada