{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","name":"Engage Api","description":"## API Pública de Engage Campaigns - Documentación\n\n### Descripción General\n\nLa 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.\n\n### Características Principales\n\n- **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    \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    \n- **Resumen de Métricas:** Estadísticas agregadas por campaña con porcentajes de lectura, interacción y error\n    \n- **Estadísticas Globales:** Métricas consolidadas del bot segmentadas por frecuencia temporal (diaria o semanal)\n    \n- **Exportación de Datos:** Descarga de detalle de campañas en formato CSV\n    \n\n---\n\n### URL Base\n\n```\nhttps://analytics-engage.agentbot.net\n\n ```\n\n---\n\n### Autenticación\n\nTodas las solicitudes a la API requieren **dos headers de autenticación**:\n\n| |\n\n| Header | Tipo | Descripción |\n| --- | --- | --- |\n| `X-Token` | Token fijo | Identificador del bot (BotID). Determina el contexto de datos a consultar. |\n| `Authorization` | Bearer JWT | Token JWT de sesión del usuario autenticado (formato `Bearer` ). |\n\n#### Ejemplo de Headers\n\n```\nX-Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...\nAuthorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\nContent-Type: application/json\n\n ```\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).\n\n---\n\n### Formato de Respuesta\n\nLas 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| Formato | Content-Type | Aplica a |\n| --- | --- | --- |\n| JSON | `application/json` | Todos los endpoints (por defecto) |\n| CSV | `text/csv; charset=utf-8` | `/campaign/{name}/details` únicamente (con `output=csv`) |\n\n---\n\n### Parámetros Comunes\n\n#### Parámetros de Fecha\n\nLa mayoría de los endpoints requieren un rango de fechas como query parameters:\n\n| Parámetro | Tipo | Formato | Descripción |\n| --- | --- | --- | --- |\n| `from` | string | `YYYY-MM-DD HH:MM:SS` (UTC) | Fecha y hora de inicio |\n| `to` | string | `YYYY-MM-DD HH:MM:SS` (UTC) | Fecha y hora de fin |\n\n**Ejemplo:**\n\n```\nfrom=2026-04-01 00:00:00\nto=2026-04-10 23:59:59\n\n ```\n\nLos valores deben estar URL-encoded en la query string (espacios como , dos puntos como `:`).\n\n#### Filtros Comunes\n\n| Parámetro | Tipo | Valores permitidos | Descripción |\n| --- | --- | --- | --- |\n| `type` | string | `one-time`, `recurrent` | Filtra campañas por tipo de ejecución |\n\n---\n\n### Endpoints Disponibles\n\n| Método | Endpoint | Descripción | `from`/`to` | Filtros opcionales |\n| --- | --- | --- | --- | --- |\n| GET | `/campaigns` | Listado de campañas del bot | Sí | `type` |\n| GET | `/campaign/{name}/details` | Detalle a nivel contacto (paginado, exportable CSV) | Sí | `type`, `output`, `limit`, `offset` |\n| GET | `/campaign/{name}/summary` | Resumen de métricas agregadas de una campaña | Sí | — |\n| GET | `/stats` | Estadísticas globales segmentadas por frecuencia | Sí | `frequency`, `type` |\n\n---\n\n### Límites de Consulta\n\n| Endpoint | Restricción |\n| --- | --- |\n| `/campaign/{name}/details` | Rango máximo de **90 días** entre `from` y `to` |\n| `/campaign/{name}/details` | `limit` máximo de **10,000** registros por request |\n\n---\n\n### Códigos de Estado HTTP\n\n| Código | Descripción |\n| --- | --- |\n| 200 | Solicitud exitosa |\n| 400 | Solicitud mal formada (parámetros inválidos o faltantes) |\n| 401 | No autenticado (token inválido o expirado) |\n| 403 | No autorizado (sin permisos para el recurso solicitado) |\n| 404 | Recurso no encontrado (campaña inexistente) |\n| 500 | Error interno del servidor |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"28918037","team":24170,"collectionId":"77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","publishedId":"2sBXqGsNEF","public":true,"publicUrl":"https://documenter-api.postman.tech/view/28918037/2sBXqGsNEF","privateUrl":"https://go.postman.co/documentation/28918037-77cc1fda-7eb1-4ed9-b96e-0794a48f69f9","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-04-27T16:37:47.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/02c5f542f949fa663f3ccaec1f516ef3bdfdf094ee4ce770a70a50f7be431db2","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXqGsNEF"}