Campaigns Performance Reports API

A technical reference for the GET /campaigns/:campaignId/report endpoint. This guide covers project-scoped performance reporting, including time-range filter parameters, aggregated message status totals (delivered, read, replied, failed), paginated recipient logs, and financial usage metrics.

Campaigns Performance Reports

Use this endpoint to retrieve delivery performance, read receipts, response metrics, and calculated usage costs for WhatsApp messages dispatched via the API. These metrics populate analytical charts and audit tables directly inside your system.

HTTP Method: GET
URL: https://api.wabpo.com/api/v1/public/campaigns/:campaignId/report
Headers:HTTPAuthorization: Bearer YOUR_API_KEY

Parameter	Type	Required	Description
projectId	String	Yes	The unique identifier for the customer workspace.
range	String	No	Time window filter. Options: today, week, month, 90d, or custom. Defaults to month.
from	String	Conditional	Start date (YYYY-MM-DD). Required only if range=custom.
to	String	Conditional	End date (YYYY-MM-DD). Required only if range=custom.
status	String	No	Filter breakdown. Options: replied (users who texted back) or failed (delivery drops).
page	Integer	No	Page number for paginated recipient logs. Defaults to 1.
limit	Integer	No	Records per page for recipient logs. Max: 100. Defaults to 25.

Campaigns Performance Reports API

Campaigns Performance Reports

Query Parameters

Example Request

Example Success Response (`200 OK`)

Summary Metrics Definitions

Troubleshooting Delivery Failures

Campaigns Performance Reports

Query Parameters

Example Request

Example Success Response (200 OK)

Summary Metrics Definitions

Troubleshooting Delivery Failures

Example Success Response (`200 OK`)