Campaign Metrics
GET/campaign/:id/metrics
Returns aggregated engagement metrics for a specific campaign, including impressions, reactions, comments, reposts, and engagement rate.
The metrics are aggregated from all posts associated with the campaign.
Date Range Filtering​
Optionally filter by date range using startDate and endDate query parameters. When specified, the API returns the metrics snapshot recorded within that date range.
How it works: Metrics are stored as cumulative totals. Each day, a snapshot captures the total impressions, reactions, etc. up to that point. The date filter returns the latest snapshot within your specified range.
Example use cases:
| Use Case | Request |
|---|---|
| Current metrics | GET /campaign/123/metrics |
| Metrics as of end of Q2 2024 | GET /campaign/123/metrics?endDate=2024-06-30 |
| Metrics for a specific period | GET /campaign/123/metrics?startDate=2024-01-01&endDate=2024-06-30 |
| Metrics from a start date to now | GET /campaign/123/metrics?startDate=2024-01-01 |
Request​
Responses​
- 200
- 401
- 404
- 429
Campaign metrics retrieved successfully
Response Headers
The maximum number of requests allowed per minute
The number of requests remaining in the current window
Unix timestamp when the rate limit window resets
Unauthorized - Invalid or missing API key
Campaign not found
Rate limit exceeded
Response Headers
The maximum number of requests allowed per minute
The number of requests remaining in the current window
Unix timestamp when the rate limit window resets
Seconds until the rate limit resets (only on 429 responses)