Automatización de reportes a través de la API en Blip

Español:
¡Hola! ¿Todo bien?

Sí, es totalmente posible automatizar la extracción de los informes que visualizas en el Administrador de Informes de Blip, especialmente los de Seguimiento de Eventos y Métricas del Chatbot, utilizando la API de la extensión Analytics de la plataforma.

Este enfoque es ideal para quienes necesitan centralizar los datos en una base de datos en la nube y ejecutar el proceso solo una vez al día, sin depender de webhooks.

Cómo funciona la extracción de datos

La API de Blip permite consultar los mismos datos que se muestran en el portal, utilizando algunos comandos HTTP simples. Mira el paso a paso:

1. Obtener todas las categorías de eventos monitoreados

Puedes usar el siguiente comando para listar todas las categorías que están siendo registradas por Analytics:

{ "id": "1", "to": "[email protected]", "method": "get", "uri": "/event-track" }

2. Consultar los contadores por categoría

Después de obtener las categorías, puedes hacer solicitudes para cada una de ellas con el siguiente formato:

GET /event-track/{categoría}?startDate=AAAA-MM-DD&endDate=AAAA-MM-DD&$take=1000

Esta llamada devuelve la cantidad de eventos registrados por día, similar a los gráficos de volumen de eventos del portal.

3. Detallar los eventos por acción

Si deseas los detalles de cada evento (por ejemplo, ver exactamente qué ocurrió dentro de una categoría), puedes usar la siguiente ruta:

GET /event-track/{categoría}/{acción}?startDate=AAAA-MM-DD&endDate=AAAA-MM-DD&$take=1000

De este modo, tendrás acceso a la lista de eventos individuales registrados en ese intervalo.

Sobre los informes del tipo "Chatbots y Métricas de Usuario"

Este informe aún no tiene una API exclusiva, pero los datos que muestra (como conversaciones, usuarios únicos, MAUs, etc.) también pueden ser extraídos a través de los endpoints mencionados anteriormente, siempre que estés rastreando esos eventos en tu flujo.

Además, puedes crear informes personalizados mediante la API, generando buckets (gráficos) y configurando los datos según tu necesidad:

• Crear informe: POST /reports

• Insertar gráficos (charts): POST /reports/{id}/charts

Ejemplo de rutina automatizada (diaria)

Aquí tienes un modelo simple de cómo puedes realizar esta recopilación automática al final del día:

1. A medianoche o al comienzo de la mañana, tu sistema llama a /event-track para listar las categorías.

2. Para cada categoría, consulta los contadores del día anterior (startDate y endDate = ayer).

3. Para las acciones relevantes, consulta los detalles de los eventos.

4. Almacena los datos en tu base de datos.

5. (Opcional) Genera un informe personalizado en Blip con los datos procesados.

Consejo importante

Los datos disponibles a través de la API o en el portal solo incluyen hasta el día anterior (D-1).

Y si deseas consultar períodos mayores, recuerda que el intervalo máximo permitido es de 90 días por solicitud.

¡Quedo a disposición!

Português:
Olá! Tudo bem? 

Sim, é totalmente possível automatizar a extração dos relatórios que você visualiza no Administrador de Relatórios do Blip, especialmente os de Acompanhamento de Eventos e Métricas de Chatbot, utilizando a API da extensão Analytics da plataforma.
 

Essa abordagem é ideal para quem precisa centralizar os dados em um banco de dados na nuvem e rodar o processo apenas uma vez por dia — sem depender de webhooks.

Como funciona a extração dos dados

A API do Blip permite que você consulte os mesmos dados exibidos no portal, usando alguns comandos HTTP simples. Veja o passo a passo:

1. Obter todas as categorias de eventos monitorados

Você pode usar o seguinte comando para listar todas as categorias que estão sendo registradas pelo Analytics:

{ "id": "1", "to": "[email protected]", "method": "get", "uri": "/event-track" }

2. Consultar os contadores por categoria

Depois de obter as categorias, você pode fazer requisições para cada uma delas com o seguinte formato:

GET /event-track/{categoria}?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD&$take=1000

Essa chamada retorna a quantidade de eventos registrados por dia — semelhante aos gráficos de volume de eventos no portal.
 

3. Detalhar os eventos por ação

Se você quiser os detalhes de cada evento (por exemplo, ver o que aconteceu exatamente dentro da categoria), pode usar o seguinte caminho:

GET /event-track/{categoria}/{acao}?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD&$take=1000

Dessa forma, você terá acesso à lista dos eventos individuais registrados naquele intervalo.

Sobre os relatórios do tipo "Chatbots e Métricas de Usuário"

Esse relatório ainda não tem uma API exclusiva, mas os dados que ele mostra (como conversas, usuários únicos, MAUs, etc.) também podem ser extraídos via os endpoints acima — desde que você esteja rastreando esses eventos no seu fluxo.

Além disso, você pode montar relatórios personalizados via API, criando buckets (gráficos) e configurando os dados conforme sua necessidade:

• Criar relatório: POST /reports

• Inserir gráficos (charts): POST /reports/{id}/charts

 Exemplo de rotina automatizada (diária)

Aqui vai um modelo simples de como você pode fazer essa coleta automática ao final do dia:

1. À meia-noite ou início da manhã, seu sistema chama /event-track para listar categorias.

2. Para cada categoria, consulta os contadores do dia anterior (startDate e endDate = ontem).

3. Para ações relevantes, consulta os detalhes dos eventos.

4. Armazena os dados no seu banco de dados.

5. (Opcional) Gera um relatório customizado no Blip com os dados processados.

 Dica importante

• Os dados disponíveis via API ou no portal só incluem até o dia anterior (D-1).

• E se quiser buscar períodos maiores, lembre-se que o intervalo máximo permitido é de 90 dias por vez.

Fico à disposição!