API exportação de Dados

A exportação de dados é útil para que o cliente consiga fazer as suas próprias análises. Sendo uma forma simples de baixar os dados.

Autenticação

Seja mais sobre a autenticação em Documentação API Autenticação

Exportação

A exportação acontece em duas etapas:

1. executar o job de exportação
2. consultar os resultados

Executar o Job de Exportação

Parâmetros

Parâmetros	Descrição	Exemplo
Data	Intervalo de extração	{
"values": {

   "date": {
       "data_type": "date",
       "operator": "between",
       "value": ["2022-08-01", "2022-08-10"]
   }

} } |

Tipos de Exportações

export_type	descrição
customers	Exporta os clientes
addresses_without_deliveries	Exporta os endereços sem loja
messages	Exporta todas as mensagens
sessions	Exporta as Sessões
users	Exporta os Usuários
chats	Exporta os Chats

POST <https://api.newtail.com.br/api/analytics/:export_type/export>

{
   "values": {
       "date": {
           "data_type": "date",
           "operator": "between",
           "value": ["2022-08-01", "2022-08-10"]
       }
   }
}

Resposta

{
    "status": "queued",
    "id": "6310890cb3dbd0699ce51330", // task_id
    "cache_minutes": 60,
    "enqueued_at": "2022-09-01T10:27:24.143755",
    "created_at": "2022-09-01T10:27:24.241117",
    "updated_at": "2022-09-01T10:27:24.241353"
}

Consultar Resultado

O parâmetro task_id é o id gerado durante a execução do export

GET <https://api.newtail.com.br/api/tasks/:task_id/result?orient=records>

{
    "count": 1,
    "columns": {
        "USER_ID": "string",
        "SOCIAL_ID": "string",
        "MAIN_PHONE": "string",
        "NAME": "string",
        "ZIPCODE": "string",
        "CREATED_AT": "datetime"
    },
    "data": [
        {
            "USER_ID": "9abf7570-1291-11ed-bc04-0bc257624cd7",
            "SOCIAL_ID": "27636186268",
            "MAIN_PHONE": "21975116209",
            "NAME": "SONIA MARIA QUEIROZ MORAES BARBOSA LIMA",
            "ZIPCODE": "22010050",
            "CREATED_AT": "2022-08-02 18:33:29"
        },
    ]
}