Campaign Metrics

Query Metrics Related to Campaigns

Fetch Campaign Metrics

get

Fetch Campaign Metrics

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

Query parameters

periodStartstring · date-timerequired

The date and time in the format 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DDTHH:MM:SS-HH:MM'.

periodEndstring · date-timeoptional

The date and time in the format 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DDTHH:MM:SS-HH:MM'.

periodGroupstring · enumoptional

The group of the period for which to fetch metrics. If provided time series will be returned and grouped by this period.

Options: minute, hour, day, month

filterstringoptional

Filter conditions for which to fetch metrics. Each condition is a string in the format of 'equals(field,value)'. Available field-value pairs are

• campaignID - UUID, can supply multiple equals conditions for multiple campaignIds
• platformID - string, can supply multiple equals conditions for multiple platforms
  • Common values are 'sms-messagebird', 'email-sparkpost', 'whatsapp'. More are possible and are specified in the summary response for a campaign.
• status - string, can supply multiple equals conditions for multiple statuses
  • Allowed values are 'invalid', 'draft', 'scheduled', 'preparing', 'inactive', 'ended', 'waiting', 'error', 'active'
• name - string, can supply multiple equals conditions for multiple campaign names

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/reporting/campaigns/metrics?periodStart=2025-03-23T02%3A00%3A32.482Z'

200

422

200

[
  {
    "summary": {
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "campaignName": "text",
      "campaignStatus": "text",
      "queued": 1,
      "skipped": 1,
      "scheduled": 1,
      "delivered": 1,
      "bounced": 1,
      "opened": 1,
      "clicked": 1,
      "unsubscribed": 1,
      "checkoutAbandonedCount": 1,
      "orderConfirmedCount": 1,
      "formViewedCount": 1,
      "formSubmittedCount": 1,
      "pageViewedCount": 1,
      "productViewedCount": 1,
      "attributedRevenue": 1,
      "currency": "text"
    },
    "timeSeries": [
      {
        "periodDate": "2025-03-23T02:00:32.482Z",
        "queued": 1,
        "skipped": 1,
        "scheduled": 1,
        "delivered": 1,
        "bounced": 1,
        "opened": 1,
        "clicked": 1,
        "unsubscribed": 1
      }
    ]
  }
]

List of campaign metrics