Campaign Metrics

Query Metrics Related to Campaigns

Fetch Campaign Metrics

get

Fetch Campaign Metrics

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

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'.

conversionMetricstring · enumOptional

The metric to use when calculating conversion rates. This is used to determine the conversion rate for the campaign. If not provided, it defaults to 'order-confirmed'.

Default: order-confirmedPossible values:

filterstringOptional

Filter conditions for fetching metrics. Each condition must be in the format: equals(field,value).

Supported field-value pairs:

• campaignID - UUID. Can supply multiple equals conditions to match multiple campaign IDs.
• name - string. Can supply multiple equals conditions to match multiple campaign names.
• status - string. Can supply multiple equals conditions to filter by campaign statuses. Allowed values:
  • draft
  • pending_review
  • scheduled
  • preparing
  • inactive
  • ended
  • waiting
  • error
  • active
• tagID - UUID. Filter by campaigns with a specific tag.
• channelID - UUID. Filter by campaigns sent via a specific channel.
• platformID - string. Can supply multiple equals conditions to match multiple platforms. Common values include: sms-messagebird, email-sparkpost, whatsapp.
• createdSince - ISO-8601 timestamp string. Filter for campaigns created after this time.
• createdUpTo - ISO-8601 timestamp string. Filter for campaigns created up to this time.

Responses

200

List of campaign metrics

application/json

422

The request did not pass validation

application/json

get

/workspaces/{workspaceId}/reporting/campaigns/metrics

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/reporting/campaigns/metrics?periodStart=2025-12-19T20%3A09%3A53.462Z HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "summary": {
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "campaignName": "text",
      "campaignCreatedDate": "2025-12-19T20:09:53.462Z",
      "campaignActivatedDate": "2025-12-19T20:09:53.462Z",
      "campaignStatus": "text",
      "campaignStage": "text",
      "platformId": "text",
      "queued": 1,
      "skipped": 1,
      "scheduled": 1,
      "sent": 1,
      "delivered": 1,
      "bounced": 1,
      "globalHoldout": 1,
      "opened": 1,
      "readOrOpened": 1,
      "clicked": 1,
      "unsubscribed": 1,
      "checkoutAbandonedCount": 1,
      "orderConfirmedCount": 1,
      "formViewedCount": 1,
      "formSubmittedCount": 1,
      "pageViewedCount": 1,
      "productViewedCount": 1,
      "attributedRevenue": 1,
      "currency": "text"
    }
  }
]