Campaign Metrics

Query Metrics Related to Campaigns

Fetch Campaign Metrics

Fetch Campaign Metrics

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

Path parameters

workspaceId*string (uuid)

The ID of the workspace

Query parameters

Response

200422

List of campaign metrics

Body

application/json

summaryobject

timeSeriesarray of object

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/reporting/campaigns/metrics?periodStart=2024-12-21T11%3A53%3A06.127Z', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

[
  {
    "summary": {
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "campaignName": "text",
      "campaignStatus": "text",
      "queued": 0,
      "skipped": 0,
      "scheduled": 0,
      "delivered": 0,
      "bounced": 0,
      "opened": 0,
      "clicked": 0,
      "unsubscribed": 0,
      "checkoutAbandonedCount": 0,
      "orderConfirmedCount": 0,
      "formViewedCount": 0,
      "formSubmittedCount": 0,
      "pageViewedCount": 0,
      "productViewedCount": 0,
      "attributedRevenue": 0,
      "currency": "text"
    },
    "timeSeries": [
      {
        "periodDate": "2024-12-21T11:53:06.127Z",
        "queued": 0,
        "skipped": 0,
        "scheduled": 0,
        "delivered": 0,
        "bounced": 0,
        "opened": 0,
        "clicked": 0,
        "unsubscribed": 0
      }
    ]
  }
]