Engage Campaigns Public API - Documentation

The Engage Public API provides programmatic access to engagement campaign data sent through WhatsApp channels. This API allows developers to integrate campaign data reporting, analysis, and export capabilities into their business applications and systems.

⬇️ Key features

Campaign List: Access to the complete catalog of campaigns within a range of dates, with filters by type of execution (one-time or recurrent)
Campaign Details: Granular information at the individual contact level, including delivery, read, and engagement status, with pagination support
Metrics Summary: Aggregated statistics by campaign with read, engagement, and error rates
Global Statistics: Consolidated bot metrics segmented by time frequency (daily or weekly)
Data Export: Download campaign details in CSV format

URL Base: https://analytics-engage.agentbot.net

▶️ Autenticación: All API requests require two authentication headers:

Header	Type	Description
X-Token	Fixed Token	Bot identifier (BotID). Determines the context of data to be queried.
Authorization	Bearer JWT	Authenticated user's session JWT token (format ).Bearer

> Example of Headers

^X-^{Token: eExNcFRrUmtOVFJsWkRKa01HRTNaalZrT0dGaFl6...}

^{Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...}

^{Content-Type: application/json}

Note: The JWT token has an expiration. Be sure to renew it before it expires to avoid responses. The JWT is obtained via OAuth from the identity provider (Auth0).401 Unauthorized.

Response Format: Responses are returned in JSON format by default. The endpoint also supports CSV export using the ./campaign/{name}/detailsoutput=csv.

Format	Content-Type	Applies to
JSON	application/json	All Endpoints (Default)
CSV	text/csv; charset=utf-8	/campaign/{name}/details only (with output=csv)

Common Parameters

Date Parameters: Most endpoints require a date range as query parameters:

Parameter	Type	Format	Description
from	string	YYYY-MM-DD HH:MM:SS (UTC)	Start Date and Time
to	string	YYYY-MM-DD HH:MM:SS (UTC)	End Date and Time

> Example:

^{from=2026-04-01 00:00:00
to=}^{2026-04-10 23:59:59}

Note: The values must be URL-encoded in the query string (spaces such as , colon as ). :

Common Filters:

Parameter	Type	Allowed values	Description
type	string	one-time, recurrent	Filter campaigns by execution type

Available Endpoints

Method	Endpoint	Description	from/to	Optional filters
GET	/campaigns	List bot campaigns	Yes	type
GET	/campaign/{name}/details	Contact-level detail (paginated, exportable CSV)	Yes	type, output, limit, offset
GET	/campaign/{name}/summary	Summary of aggregated metrics for a campaign	Yes	-
GET	/stats	Global statistics segmented by frequency	Yes	frequency, type

Query Limits

Endpoint	Restricción
/campaign/{name}/details	Maximum range of 90 days between and from to
/campaign/{name}/details	Limit: Maximum of 10,000 records per request

HTTP Status Codes

Code	Description
200	Application Successful
400	Malformed request (invalid or missing parameters)
401	Authenticated (invalid or expired token)
403	Unauthorized (no permissions for the requested resource)
404	Resource not found (campaign non-existent)
500	Internal Server Error

Using the API, you can retrieve the information in the fields listed below. To learn how, click on the links under each respective heading:

GETSummary: Returns aggregated metrics and a statistical summary for a campaign within a date range.
GET Stats: Returns consolidated message metrics for a bot within a date range. The data is segmented according to the frequency parameter.
GET Campaigns: Returns the list of campaigns for a specific bot within a date range.
GET Details: Returns granular information at the individual contact level for a specific campaign. Supports pagination and export in CSV.