Analytics

Campaign analytics over time

One point per interval so you can chart a campaign – this series carries bounces AND unsubscribes, so those rates are chartable without extra calls. Long windows auto-coarsen (day → week → month); the response says which interval it used.

Requires one of the following scopes: metrics:read, all:read, all:all.

get/v1/campaigns/{id}/analytics/timeseries

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/campaigns/{id}/analytics/timeseries
  • Auth: HTTP bearer

Path parameters

idstring required
Example:c1a2b3d4-...

Campaign id.

Query parameters

startDatestring
Example:2026-06-01T00:00:00Z

Start of the reporting window (ISO-8601). ⚠️ Reporting is by whole calendar day in your workspace timezone – the time component is ignored, so this date counts from the START of that day.

endDatestring
Example:2026-06-30T23:59:59Z

End of the reporting window (ISO-8601). Defaults to now. ⚠️ Inclusive and by whole calendar day (time component ignored) – this counts through the END of that day in your workspace timezone.

excludeOOOboolean
Example:true

Exclude out-of-office auto-replies from reply counts and reply rate. Mirrors the dashboard toggle.

interval'day' | 'week' | 'month'
Example:day

Bucket size. Coarser intervals are auto-selected for long windows to keep the series readable.

Response

campaignIdstring required
interval'day' | 'week' | 'month' required

Bucket size actually used – may be coarser than requested for long windows.

Example response

{
  "campaignId": "c1a2b3d4-...",
  "period": {
    "start": "2026-06-01T00:00:00.000Z",
    "end": "2026-06-30T23:59:59.000Z",
    "retentionDays": 90
  },
  "interval": "day",
  "data": [
    {
      "timestamp": "2026-06-14T00:00:00.000Z",
      "sent": 120,
      "delivered": 118,
      "opens": {
        "total": 240,
        "uniqueLeads": 180
      },
      "clicks": {
        "total": 240,
        "uniqueLeads": 180
      },
      "replies": 4,
      "bounces": 2,
      "unsubscribed": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.