Pesquisas e RespostasListar Solicitacoes

Listar Solicitações

Retorna uma lista paginada com as solicitações de pesquisa de determinada unidade. Inclui todos os canais: SMS, e-mail, WhatsApp, Link/QRCode e InApp.

curl -X POST "https://api.amplifique.me/partners/cf/requests?limit=42&page=25&start=01/01/2024&end=31/12/2024&include_survey=true&open_start=01/01/2024&open_end=31/12/2024" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
{
  "data": [
    {
      "_id": "645cfb345e8a1e02494b88bd",
      "_survey": "64147ad6e6947a3a0ca1d721",
      "channel": 6,
      "opened": true,
      "finalized": false,
      "deleted": false,
      "origin": "preview.amplifique.me/preview/60afce1ca9680b000eca2459?version=2",
      "anonymized": false,
      "attempts": 1,
      "_customer": "642598acf05534d1cd33d69a",
      "_user": "60e83e2cc59ce771be97267a",
      "_business": "629f52abca19568f84de7747",
      "custom_fields": {
        "data_nascimento": "11/01/1990"
      },
      "created_at": "2023-05-11T14:27:00.521Z",
      "opened_at": "2023-05-11T14:27:12.277Z",
      "sendings": {
        "_id": "645cfb345e8a1e02494b88c4",
        "source": 6,
        "source_status": "DELIVERED",
        "_reference": "645cfb345e8a1e02494b88bd",
        "type": "cf",
        "attempt": 1,
        "attemptDelay": 0,
        "_business": "629f52abca19568f84de7747",
        "providerSource": "TakeBlip",
        "providerId": "86777ea5-197f-4318-b194-1886db496623",
        "created_at": "2023-05-11T14:27:00.538Z",
        "updated_at": "2023-05-11T14:57:02.566Z"
      },
      "customer": {
        "name": "Robson",
        "email": "robson@amplifique.me",
        "tel": "+5511997273014",
        "custom_fields": {
          "data_nascimento": "11/09/1997"
        }
      },
      "deleted_by": {}
    }
  ],
  "total": 123
}
POST
/partners/cf/requests
POST
API Key (header: Authorization)
Authorizationstring
Required

API key (sent in header)

query
limitinteger

Limite de solicitações retornadas por página. Mín: 1, Máx: 1000

query
pageinteger

Número da página a retornar. Mín: 0

query
startstring

Data inicial de criação da solicitação (dd/MM/yyyy). Requer end.

query
endstring

Data final de criação da solicitação (dd/MM/yyyy). Requer start.

query
include_surveyboolean

Quando true, retorna a estrutura completa da pesquisa junto de cada solicitação.

query
open_startstring

Data inicial de abertura da pesquisa (dd/MM/yyyy). Requer open_end.

query
open_endstring

Data final de abertura da pesquisa (dd/MM/yyyy). Requer open_start.

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 solicitações retornadas por página. Mín: 1, Máx: 1000

pageinteger

Número da página a retornar. Mín: 0

startstring

Data inicial de criação da solicitação (dd/MM/yyyy). Requer end.

endstring

Data final de criação da solicitação (dd/MM/yyyy). Requer start.

include_surveyboolean

Quando true, retorna a estrutura completa da pesquisa junto de cada solicitação.

open_startstring

Data inicial de abertura da pesquisa (dd/MM/yyyy). Requer open_end.

open_endstring

Data final de abertura da pesquisa (dd/MM/yyyy). Requer open_start.

Responses

dataarray
totalinteger

Total de registros encontrados