Get Campaign Statistics

GET 
/emails/locations/:locationId/campaigns/stats/:source/:sourceId

Get statistics for email campaigns, workflows, or bulk actions

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location ID

source stringrequired

Source type: email-campaigns, workflow-campaigns, or bulk-actions

Available optionsemail-campaignsworkflow-campaignsbulk-actions

sourceId stringrequired

Source ID of the email campaign, workflow campaign, or bulk action

subSourceId string

Workflow action ID. Only valid when source is workflow-campaigns

application/json

Success

application/json

Schema

Schema

locationIdstringrequired

Location ID

sourcestringrequired
Source type
Available optionsemail-campaignsworkflow-campaignsbulk-actions
sourceIdstringrequired

Source ID

subSourceIdstring

Workflow action ID

statsobjectrequired

Email performance metrics

traceIdstring

Trace ID of the request

Example (auto)

{
  "locationId": "abc123",
  "source": "email-campaigns",
  "sourceId": "campaign123",
  "subSourceId": "step001",
  "stats": {
    "sent": 1020,
    "accepted": 5,
    "delivered": 1000,
    "opened": 450,
    "clicked": 120,
    "unsubscribed": 5,
    "complained": 2,
    "permanentFail": 15,
    "temporaryFail": 3,
    "rejected": 10,
    "failed": 5,
    "replied": 25,
    "openRate": 45,
    "clickRate": 12,
    "unsubscribeRate": 0.5,
    "complaintRate": 0.2,
    "bounceRate": 1.76,
    "replyRate": 2.5
  },
  "traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}