Skip to main content

Documentation Index

Fetch the complete documentation index at: https://montereyfinancial.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Monterey provides campaign analytics through aggregated statistics, time-series data, and raw engagement events.

​
Campaign statistics

EndpointPurpose
GET /campaign-statistics/List statistics for all campaigns (optional date range filter)
GET /campaign-statistics/{campaign_id}Get statistics for a single campaign
GET /campaign-statistics/{campaign_id}/time-seriesTime-series breakdown

​
Time-series granularity

The time-series endpoint accepts a granularity parameter:
ValueDescription
hourHourly data points
dayDaily aggregation
weekWeekly aggregation
monthMonthly aggregation
curl "http://localhost:8000/campaign-statistics/{id}/time-series?granularity=day" \
  -H "Authorization: Bearer <token>" \
  -H "workspace_id: <workspace-id>"

​
Engagement events

Raw engagement events (opens, clicks, bounces) are available through the events API: 
curl "http://localhost:8000/campaign-events/?event_type=open&date_from=2026-01-01" \
  -H "Authorization: Bearer <token>" \
  -H "workspace_id: <workspace-id>"

​
Bounce tracking

​
Real-time bounces

Bounce events from campaign sends are tracked automatically via webhooks. See webhooks.
EndpointPurpose
GET /bounce-events/List bounce events (filter by email, workspace)
GET /bounce-events/{id}Get bounce event details

​
Historical bounces

The historical bounces API provides access to bounce records synced from Campaigner’s full history:
EndpointPurpose
GET /historical-bounces/List with filters for email, bounce type, account number, date range
GET /historical-bounces/exportExport bounces as a CSV file
POST /historical-bounces/backfillTrigger a background sync from Campaigner
The backfill endpoint dispatches a Celery task to sync bounce history. Pass full_backfill: true to sync all records, or use since for incremental updates.