Pesquisas e RespostasListar Solicitacoes

Listar Solicitações

Esse endpoint retornará uma lista com as solicitações das pesquisas de determinada unidade. (solicitações podem ser em qualquer canal, incluindo pessoas elegíveis no InApp e pessoas que acessaram o Link/QRCode e preencheram os dados)

curl -X POST "https://api.amplifique.me/partners/cf/requests?limit=42&page=25&start=2024-12-25&end=2024-12-25&include_survey=true&open_start=2024-12-25&open_end=2024-12-25" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
"{
  "data": [
    {
      "_id": "645cfb345e8a1e02494b88bd", //String | ID da Resposta/Solicitação
      "_survey": "64147ad6e6947a3a0ca1d721", //String |ID da Pesquisa
      "channel": 6, //Integer | Canal de envio 0-> SMS, 1->EMAIL, 2-> WHATSAPP, 3-> LINK, 4-> INAPP, 6-> WhatsApp API
      "opened": true, //Boolean | se a pesquisa foi aberta
      "finalized": false, //Boolean | se a pesquisa foi finalizada
      "deleted": false, //Boolean | se a solicitação está na lixeira.
      "origin": "preview.amplifique.me/preview/60afce1ca9680b000eca2459?version=2", //String | Origem Link ou InApp apenas
      "anonymized": false, //Boolean | se a solicitação foi anonimizada.
      "attempts": 1, //Integer | Número de tentativas de envio (SmartFollowUp)
      "_customer": "642598acf05534d1cd33d69a", //String | ID do contato
      "_user": "60e83e2cc59ce771be97267a", //String | ID do usuário que solicitou
      "_business": "629f52abca19568f84de7747", //String | ID da unidade
      "custom_fields": {
        //Object | Contém os campos customizados da resposta
        "data_nascimento": "11/01/1990"
      },
      "created_at": "2023-05-11T14:27:00.521Z", //Date | Data de criação da Solicitação
      "opened_at": "2023-05-11T14:27:12.277Z", //Date | Quando foi aberta
      "sendings": {
        //Object | Contém os dados de envio
        "_id": "645cfb345e8a1e02494b88c4", //String | ID do envio
        "source": 6, //Integer | Canal de envio 0-> SMS, 1->EMAIL, 2-> WHATSAPP, 3-> LINK, 4-> INAPP, 6-> WhatsApp API
        "source_status": "DELIVERED", //String | Status do envio ERROR, PENDING, DELIVERED/SENT, CREATED
        "_reference": "645cfb345e8a1e02494b88bd", //String | ID da Resposta/Solicitação
        "type": "cf", //String | Tipo de envio cf-> Surveys
        "attempt": 1, //Integer | Número da tentativa de envio (SmartFollowUp)
        "attemptDelay": 0, //Integer | Tempo de espera da tentativa (dias) (SmartFollowUp)
        "_business": "629f52abca19568f84de7747", //String | ID da unidade
        "providerSource": "TakeBlip", //String | Provedor de envio
        "providerId": "86777ea5-197f-4318-b194-1886db496623", //String | ID do envio no provedor
        "created_at": "2023-05-11T14:27:00.538Z", //Date | Data de criação do envio
        "updated_at": "2023-05-11T14:57:02.566Z" //Date | Data da última atualização do envio
      },
      "customer": {
        //Object | Objeto com os dados do Contato
        "name": "Robson", //String | Nome do contato
        "email": "robson@amplifique.me", //String | E-mail do contato
        "tel": "+5511997273014", //String | Telefone do contato
        "custom_fields": {
          //Object | Contém os campos customizados do contato
          "data_nascimento": "11/09/1997"
        }
      },
      "deleted_by": {} //Object | Dados do Usuário que inseriu a resposta na lixeira.
    }
  ],
  "total": 123
}
"
POST
/partners/cf/requests
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
open_startstring

A partir da abertura em determinada Data. Necessita do parâmetro open_end para funcionar

Format: date
query
open_endstring

Abertura em até determinada Data. Necessita do parâmetro open_start para funcionar

Format: date
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

open_startstring

A partir da abertura em determinada Data. Necessita do parâmetro open_end para funcionar

open_endstring

Abertura em até determinada Data. Necessita do parâmetro open_start para funcionar

Responses

dataarray
totalinteger