{"info":{"_postman_id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","name":"Engage Api","description":"

API Pública de Engage Campaigns - Documentación

Descripción General

La API Pública de Engage proporciona acceso programático a datos de campañas de engagement enviadas a través de canales de WhatsApp. Esta API permite a los desarrolladores integrar capacidades de reporting, análisis y exportación de datos de campañas en sus aplicaciones y sistemas empresariales.

Características Principales

Listado de Campañas: Acceso al catálogo completo de campañas dentro de un rango de fechas, con filtros por tipo de ejecución (one-time o recurrent)
\n
Detalles de Campaña: Información granular a nivel de contacto individual, incluyendo estado de entrega, lectura e interacción, con soporte de paginación
\n
Resumen de Métricas: Estadísticas agregadas por campaña con porcentajes de lectura, interacción y error
\n
Estadísticas Globales: Métricas consolidadas del bot segmentadas por frecuencia temporal (diaria o semanal)
\n
Exportación de Datos: Descarga de detalle de campañas en formato CSV
\n

URL Base

https://analytics-engage.agentbot.net\n\n

Autenticación

Todas las solicitudes a la API requieren dos headers de autenticación:

| |

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Tipo	Descripción
`X-Token`	Token fijo	Identificador del bot (BotID). Determina el contexto de datos a consultar.
`Authorization`	Bearer JWT	Token JWT de sesión del usuario autenticado (formato `Bearer` ).

Ejemplo de Headers

X-Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...\nAuthorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\nContent-Type: application/json\n\n

Nota: El token JWT tiene expiración. Asegúrese de renovarlo antes de que expire para evitar respuestas 401 Unauthorized. El JWT se obtiene mediante autenticación OAuth contra el proveedor de identidad (Auth0).

Formato de Respuesta

Las respuestas se devuelven en formato JSON por defecto. El endpoint /campaign/{name}/details soporta además exportación en CSV mediante el parámetro output=csv.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Formato	Content-Type	Aplica a
JSON	`application/json`	Todos los endpoints (por defecto)
CSV	`text/csv; charset=utf-8`	`/campaign/{name}/details` únicamente (con `output=csv`)

Parámetros Comunes

Parámetros de Fecha

La mayoría de los endpoints requieren un rango de fechas como query parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parámetro	Tipo	Formato	Descripción
`from`	string	`YYYY-MM-DD HH:MM:SS` (UTC)	Fecha y hora de inicio
`to`	string	`YYYY-MM-DD HH:MM:SS` (UTC)	Fecha y hora de fin

Ejemplo:

from=2026-04-01 00:00:00\nto=2026-04-10 23:59:59\n\n

Los valores deben estar URL-encoded en la query string (espacios como , dos puntos como :).

Filtros Comunes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parámetro	Tipo	Valores permitidos	Descripción
`type`	string	`one-time`, `recurrent`	Filtra campañas por tipo de ejecución

Endpoints Disponibles

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Método	Endpoint	Descripción	`from`/`to`	Filtros opcionales
GET	`/campaigns`	Listado de campañas del bot	Sí	`type`
GET	`/campaign/{name}/details`	Detalle a nivel contacto (paginado, exportable CSV)	Sí	`type`, `output`, `limit`, `offset`
GET	`/campaign/{name}/summary`	Resumen de métricas agregadas de una campaña	Sí	—
GET	`/stats`	Estadísticas globales segmentadas por frecuencia	Sí	`frequency`, `type`

Límites de Consulta

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint	Restricción
`/campaign/{name}/details`	Rango máximo de 90 días entre `from` y `to`
`/campaign/{name}/details`	`limit` máximo de 10,000 registros por request

Códigos de Estado HTTP

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Código	Descripción
200	Solicitud exitosa
400	Solicitud mal formada (parámetros inválidos o faltantes)
401	No autenticado (token inválido o expirado)
403	No autorizado (sin permisos para el recurso solicitado)
404	Recurso no encontrado (campaña inexistente)
500	Error interno del servidor

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28918037","collectionId":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","publishedId":"2sBXqGsNEF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-04-27T16:37:47.000Z"},"item":[{"name":"Summary","id":"46de1c89-818a-4b5f-a52b-9d91b01ecf82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Token","value":"xxxxxxxxx"},{"key":"Authorization","value":"Bearer xxxxxxx"},{"key":"Content-Type","value":"application/json"}],"url":"https://analytics-engage.agentbot.net/campaign/promo_welcome_test/summary?from=2026-04-01%2000%3A00%3A00&to=2026-04-10%2023%3A59%3A59","description":"

Resumen de Campaña

Retorna las métricas agregadas y el resumen estadístico de una campaña dentro de un rango de fechas.

GET /campaign/{name}/summary\n\n

Path Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parámetro	Tipo	Requerido	Descripción
`name`	string	Sí	Nombre identificador de la campaña

Query Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parámetro	Tipo	Requerido	Descripción
`from`	string	Sí	Fecha y hora de inicio (`YYYY-MM-DD HH:MM:SS`)
`to`	string	Sí	Fecha y hora de fin (`YYYY-MM-DD HH:MM:SS`)

Headers requeridos:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Requerido	Descripción
`X-Token`	Sí	BotID - Token de acceso
`Authorization`	Sí	Bearer token JWT de sesión
`Content-Type`	Sí	`application/json`

Ejemplo de Request:

bash

curl --location 'https://analytics-engage.agentbot.net/campaign/promo_welcome_test/summary?from=2026-04-01 00:00:00&to=2026-04-10 23:59:59' \\\n--header 'X-Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...' \\\n--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJhdXRoMHwxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTcwMDAwMDAwMH0.SIGNATURE_PLACEHOLDER' \\\n--header 'Content-Type: application/json'\n\n

Ejemplo de Response:

json

{\n    \"campaign_id\": \"a1b2c3d4-5678-9101-abcd-ef1234567890\",\n    \"campaign_name\": \"promo_welcome_test\",\n    \"template_name\": \"welcome_april_template\",\n    \"channel_name\": \"Wpp Demo Company +1 555 123 4567\",\n    \"campaign_type\": \"one-time\",\n    \"sent\": 2308,\n    \"received\": 2196,\n    \"readed\": 1156,\n    \"error\": 476,\n    \"total\": 2308,\n    \"interacted\": 62,\n    \"readed_percent\": 50.09,\n    \"interacted_percent\": 2.69,\n    \"error_percent\": 17.1\n}\n\n

Campos de Response:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descripción
`campaign_id`	string	UUID identificador único de la campaña
`campaign_name`	string	Nombre de la campaña
`template_name`	string	Nombre del template de mensaje utilizado
`channel_name`	string	Nombre del canal de WhatsApp asociado
`campaign_type`	string	Tipo de campaña: `one-time` o `recurrent`
`sent`	integer	Cantidad total de mensajes enviados
`received`	integer	Cantidad de mensajes entregados al destinatario
`readed`	integer	Cantidad de mensajes leídos por el destinatario
`error`	integer	Cantidad de mensajes con error de entrega
`total`	integer	Total de mensajes procesados en la campaña
`interacted`	integer	Cantidad de destinatarios que interactuaron
`readed_percent`	float	Porcentaje de mensajes leídos sobre el total
`interacted_percent`	float	Porcentaje de interacciones sobre el total
`error_percent`	float	Porcentaje de errores sobre el total

","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","name":"Engage Api","type":"collection"}},"urlObject":{"protocol":"https","path":["campaign","promo_welcome_test","summary"],"host":["analytics-engage","agentbot","net"],"query":[{"key":"from","value":"2026-04-01%2000%3A00%3A00"},{"key":"to","value":"2026-04-10%2023%3A59%3A59"}],"variable":[]}},"response":[],"_postman_id":"46de1c89-818a-4b5f-a52b-9d91b01ecf82"},{"name":"Stats","id":"8ea7bde0-544e-4263-8c41-b0a73b24e806","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Token","value":"xxxxxxxx"},{"key":"Authorization","value":"xxxxxxxx"},{"key":"Content-Type","value":"application/json"}],"url":"https://analytics-engage.agentbot.net/stats?from=2026-04-01%2000%3A00%3A00&to=2026-04-10%2023%3A59%3A59","description":"

4. Estadísticas Globales

Retorna métricas consolidadas de mensajes para un bot dentro de un rango de fechas. Los datos se segmentan según el parámetro de frecuencia.

GET /stats\n\n

Query Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parámetro	Tipo	Requerido	Descripción
`from`	string	Sí	Fecha y hora de inicio (`YYYY-MM-DD HH:MM:SS` UTC)
`to`	string	Sí	Fecha y hora de fin (`YYYY-MM-DD HH:MM:SS` UTC)
`frequency`	string	No	Frecuencia de segmentación: `daily` o `weekly`
`type`	string	No	Filtro por tipo de campaña: `one-time` o `recurrent`

Headers requeridos:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Requerido	Descripción
`X-Token`	Sí	BotID - Token de acceso
`Authorization`	Sí	Bearer token JWT de sesión
`Content-Type`	Sí	`application/json`

Ejemplo de Request:

bash

curl --location 'https://analytics-engage.agentbot.net/stats?from=2026-04-01 00:00:00&to=2026-04-10 23:59:59' \\\n--header 'X-Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...' \\\n--header 'Authorization: Bearer eyJhbG234232232ciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJhdXRoMHwxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTcwMDAwMDAwMH0.SIGNATURE_PLACEHOLDER' \\\n--header 'Content-Type: application/json'\n\n

Con filtros opcionales:

bash

curl --location 'https://analytics-engage.agentbot.net/stats?from=2026-04-01 00:00:00&to=2026-04-10 23:59:59&frequency=daily&type=one-time' \\\n--header 'X-Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...' \\\n--header 'Authorization: Bearer ey23232JhbGciOiJ23232323SUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJhdXRoMHwxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTcwMDAwMDAwMH0.SIGNATURE_PLACEHOLDER' \\\n--header 'Content-Type: application/json'\n\n

Ejemplo de Response:

La respuesta es un array de objetos. Cada objeto representa un segmento temporal según la frecuencia solicitada. Si no se especifica frequency, retorna un único segmento con el rango completo.

json

[\n    {\n        \"segment\": \"2026-04-01 00:00:00 - 2026-04-10 23:59:59\",\n        \"stats\": {\n            \"total\": 86290,\n            \"read\": 56140,\n            \"not_delivered\": 1116,\n            \"delivered\": 76828,\n            \"error\": 8346\n        }\n    }\n]\n\n

Campos de Response — [] (array raíz):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descripción
`segment`	string	Rango temporal del segmento (formato: `YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS`)
`stats`	object	Objeto con las métricas agregadas del segmento

Campos de Response — stats****:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descripción
`total`	integer	Total de mensajes procesados en el segmento
`read`	integer	Cantidad de mensajes leídos por el destinatario
`not_delivered`	integer	Cantidad de mensajes no entregados
`delivered`	integer	Cantidad de mensajes entregados al destinatario
`error`	integer	Cantidad de mensajes con error

Nota: Cuando se utiliza frequency=daily, el array contendrá un objeto por cada día dentro del rango. Con frequency=weekly, un objeto por cada semana.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","name":"Engage Api","type":"collection"}},"urlObject":{"protocol":"https","path":["stats"],"host":["analytics-engage","agentbot","net"],"query":[{"key":"from","value":"2026-04-01%2000%3A00%3A00"},{"key":"to","value":"2026-04-10%2023%3A59%3A59"}],"variable":[]}},"response":[],"_postman_id":"8ea7bde0-544e-4263-8c41-b0a73b24e806"},{"name":"Campaigns","id":"c5f2958c-ddbd-4a42-9354-bfc0bc5c6ef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Token","value":"T1dRMFpEUXpNR1V6TnpoaFkyWXpZalprTkRNME5EZzRNemc1TVRnd1pUQT0="},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik5VSTBRa0V4TmpZNU5rUTJOek5GUmpWRU1qQTBOMFU1UVRZelJUQkVSamhDUkRreU5ESXhOZyJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtYWx0ZXJuYXRpdmVfaWQiOiIiLCJ4LWN1cnJlbnRfdXNlcl9yb2xlcyI6MTk5NTgsIngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDYxNjVkYjczN2YxNTViMDA3MWIxNmQyYyJ9LCJuaWNrbmFtZSI6Im1zb2xhbm8iLCJuYW1lIjoiTWFyY29zIFNvbGFubyIsInBpY3R1cmUiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci85NGJkYTAxYTViOTE2NzhlMDUzYTRjMGNmYWZiYTU1ND9zPTQ4MCZyPXBnJmQ9aHR0cHMlM0ElMkYlMkZjZG4uYXV0aDAuY29tJTJGYXZhdGFycyUyRm1zLnBuZyIsInVwZGF0ZWRfYXQiOiIyMDI2LTA0LTIyVDEzOjU4OjQ3Ljc4MVoiLCJlbWFpbCI6Im1zb2xhbm9AYWl2by5jbyIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJpc3MiOiJodHRwczovL2Fpdm9jby5hdXRoMC5jb20vIiwiYXVkIjoiUnhOMlo5SUIxYmhuZ1RBNjAyeHRUQ1FhVE5KRFJWbTgiLCJzdWIiOiJhdXRoMHw2MTY1ZGI3MzdmMTU1YjAwNzFiMTZkMmMiLCJpYXQiOjE3NzY4NjYzMjgsImV4cCI6MTc3NjkwMjMyOH0.N8kS7wHEoJ5WyIBQWino0lM4-xQs2aXhH3fwHJb1CKVZtLy47YtBuVypqeFS2HvDGg4SLsEvGLRVxmHOq1b73PQcjBFHIJqcXRrOPagbuISjaFiCOgBgsA6jpOfO3cocwRFEoTK02ZjjCNCihDCHThlOiwed7NvYtdS1W0cs-pq_RbPMwEcUQv3Dj3QxQwMU3PkzVY2Ia40zungC4e-iiZvoXp-5y4gI7EA2aqwFYpw_x2QnGIAbrOnNsOuIEwBIJI1XofqzUyhvzkLIfltP2WTq9CvkC_RusYUog9aWCLrYrXs3zlGMvmuSiG7wplDYvHU-JwHZkr57a-DKfbnLWA"},{"key":"Content-Type","value":"application/json"}],"url":"https://analytics-engage.agentbot.net/campaigns?from=2026-03-01%2003%3A00%3A00&to=2026-03-17%2003%3A00%3A00","description":"

1. Listar Campañas

Retorna el listado de campañas para un bot específico dentro de un rango de fechas.

GET /campaigns\n\n

Query Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parámetro	Tipo	Requerido	Descripción
`from`	string	Sí	Fecha y hora de inicio (`YYYY-MM-DD HH:MM:SS` UTC)
`to`	string	Sí	Fecha y hora de fin (`YYYY-MM-DD HH:MM:SS` UTC)
`type`	string	No	Filtro por tipo: `one-time` o `recurrent`

Headers requeridos:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Requerido	Descripción
`X-Token`	Sí	BotID - Token de acceso
`Authorization`	Sí	Bearer token JWT de sesión
`Content-Type`	Sí	`application/json`

Ejemplo de Request:

bash

curl --location 'https://analytics-engage.agentbot.net/campaigns?from=2026-04-01 00:00:00&to=2026-04-10 23:59:59' \\\n--header 'X-Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...' \\\n--header 'Authorization: Bearer ey442321JhbGciO232iJSUzI1N3232iIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJhdXRoMHwxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTcwMDAwMDAwMH0.SIGNATURE_PLACEHOLDER' \\\n--header 'Content-Type: application/json'\n\n

Con filtro por tipo:

bash

curl --location 'https://analytics-engage.agentbot.net/campaigns?from=2026-04-01 00:00:00&to=2026-04-10 23:59:59&type=one-time' \\\n--header 'X-Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...' \\\n--header 'Authorization: Bearer eyJhbGci12312421OiJSUzI1NiIsInR5cCI4124123216IkpXVCJ9.eyJzdWIiOiJhdXRoMHwxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTcwMDAwMDAwMH0.SIGNATURE_PLACEHOLDER' \\\n--header 'Content-Type: application/json'\n\n

","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","name":"Engage Api","type":"collection"}},"urlObject":{"protocol":"https","path":["campaigns"],"host":["analytics-engage","agentbot","net"],"query":[{"key":"from","value":"2026-03-01%2003%3A00%3A00"},{"key":"to","value":"2026-03-17%2003%3A00%3A00"}],"variable":[]}},"response":[],"_postman_id":"c5f2958c-ddbd-4a42-9354-bfc0bc5c6ef0"},{"name":"Details","id":"dd403eb5-2e10-4657-9396-aa99e99f916c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Token","value":"xxxxxxxx"},{"key":"Authorization","value":"xxxxxxxx"},{"key":"Content-Type","value":"application/json"}],"url":"https://analytics-engage.agentbot.net/campaign/promo_welcome_test/details?from=2026-04-01%2000%3A00%3A00&to=2026-04-10%2023%3A59%3A59&limit=100&offset=0","description":"

Detalle de Campaña

Retorna información granular a nivel de contacto individual para una campaña específica. Soporta paginación y exportación en CSV.

GET /campaign/{name}/details\n\n

Path Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parámetro	Tipo	Requerido	Descripción
`name`	string	Sí	Nombre identificador de la campaña

Query Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parámetro	Tipo	Requerido	Restricciones	Descripción
`from`	string	Sí	Formato: `YYYY-MM-DD HH:MM:SS` (UTC)	Fecha y hora de inicio del rango
`to`	string	Sí	Formato: `YYYY-MM-DD HH:MM:SS` (UTC). Máximo 90 días desde `from`	Fecha y hora de fin del rango
`limit`	integer	Sí	Entre `1` y `10000`	Cantidad de registros a retornar `Maximo 10000 registros por pagina.`
`offset`	integer	Sí	`>0`	Cantidad de registros a omitir (paginación)
`type`	string	No	`one-time` o `recurrent`	Filtro por tipo de campaña
`output`	string	No	`json` (default) o `csv`	Formato de respuesta. Si `csv`, retorna archivo `engage_report.csv`

Límite de rango: El rango máximo entre from y to es de 90 días.

Headers requeridos:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Requerido	Descripción
`X-Token`	Sí	BotID - Token de acceso
`Authorization`	Sí	Bearer token JWT de sesión
`Content-Type`	Sí	`application/json`

Ejemplo de Request:

bash

curl --location 'https://analytics-engage.agentbot.net/campaign/promo_welcome_test/details?from=2026-04-01 00:00:00&to=2026-04-10 23:59:59&limit=100&offset=0' \\\n--header 'X-Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...' \\\n--header 'Authorization: Bearer eyJhbGci12412412OiJSUzI1NiI2141241231sInR5cCI6IkpXVCJ9.eyJzdWIiOiJhdXRoMHwxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTcwMDAwMDAwMH0.SIGNATURE_PLACEHOLDER' \\\n--header 'Content-Type: application/json'\n\n

Ejemplo de Response (JSON):

json

{\n  \"metadata\": {\n    \"offset\": 0,\n    \"limit\": 100,\n    \"total\": 250\n  },\n  \"data\": [\n    {\n      \"campaign_id\": \"a1b2c3d4-5678-9101-abcd-ef1234567890\",\n      \"campaign_name\": \"promo_welcome_test\",\n      \"template_name\": \"welcome_april_template\",\n      \"sent_date\": \"2026-04-02T10:00:00Z\",\n      \"event_date\": \"2026-04-02T10:05:32Z\",\n      \"phone_number\": \"+15551234567\",\n      \"status\": \"readed\",\n      \"engagement_type\": \"button_click\",\n      \"engagement_content\": \"Ver más\"\n    }\n  ]\n}\n\n

Campos de Response — metadata****:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descripción
`offset`	integer	Desplazamiento actual en la paginación
`limit`	integer	Cantidad de registros solicitados
`total`	integer	Total de registros disponibles para el filtro

Campos de Response — data[]****:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descripción
`campaign_id`	string	UUID identificador único de la campaña
`campaign_name`	string	Nombre de la campaña
`template_name`	string	Nombre del template de mensaje utilizado
`sent_date`	string	Fecha y hora de envío del mensaje (ISO 8601)
`event_date`	string	Fecha y hora del último evento registrado (ISO 8601)
`phone_number`	string	Número de teléfono del destinatario
`status`	string	Estado del mensaje: `sent`, `received`, `readed`, `error`
`engagement_type`	string	Tipo de interacción del usuario (si aplica)
`engagement_content`	string	Contenido de la interacción (ej: texto del botón presionado)

Exportación CSV:

Para obtener los datos en formato CSV, agregue output=csv a los query parameters. El archivo descargado se llama engage_report.csv.

bash

curl --location 'https://analytics-engage.agentbot.net/campaign/promo_welcome_test/details?from=2026-04-01 00:00:00&to=2026-04-10 23:59:59&limit=10000&offset=0&output=csv' \\\n--header 'X-Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...' \\\n--header 'Authorization: Bearer eyJ12hbGciO123124iJSUzI1NiIsInR5412412321cCI6IkpXVCJ9.eyJzdWIiOiJhdXRoMHwxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTcwMDAwMDAwMH0.SIGNATURE_PLACEHOLDER' \\\n--header 'Content-Type: application/json' \\\n--output engage_report.csv\n\n

","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","name":"Engage Api","type":"collection"}},"urlObject":{"protocol":"https","path":["campaign","promo_welcome_test","details"],"host":["analytics-engage","agentbot","net"],"query":[{"key":"from","value":"2026-04-01%2000%3A00%3A00"},{"key":"to","value":"2026-04-10%2023%3A59%3A59"},{"key":"limit","value":"100"},{"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"dd403eb5-2e10-4657-9396-aa99e99f916c"}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"a344c7db-09bf-4a61-97f8-f109b0934f51","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"ee31a533-2556-491b-ba76-3c1392e51f24","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}]}