Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaignKey}
/
report
/
statistics
Get live campaign statistics
curl --request GET \
  --url https://api.railmail.app/api/v1/campaigns/{campaignKey}/report/statistics \
  --header 'X-API-Key: <api-key>'
{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "totalSent": 123,
  "totalDelivered": 123,
  "totalBounced": 123,
  "hardBounced": 123,
  "softBounced": 123,
  "totalOpened": 123,
  "uniqueOpens": 123,
  "totalClicked": 123,
  "uniqueClicks": 123,
  "totalUnsubscribed": 123,
  "spamComplaints": 123,
  "deliveryRate": 123,
  "openRate": 123,
  "clickThroughRate": 123,
  "clickToOpenRate": 123,
  "unsubscribeRate": 123,
  "bounceRate": 123,
  "engagementScore": 123,
  "collectedAt": "2023-11-07T05:31:56Z",
  "lastUpdatedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Path Parameters

campaignKey
string
required

Campaign key (e.g. APIT-001).

Response

Statistics

campaignId
string<uuid>
status
string | null
totalSent
integer<int64>
totalDelivered
integer<int64>
totalBounced
integer<int64>
hardBounced
integer<int64>
softBounced
integer<int64>
totalOpened
integer<int64>
uniqueOpens
integer<int64>
totalClicked
integer<int64>
uniqueClicks
integer<int64>
totalUnsubscribed
integer<int64>
spamComplaints
integer<int64>
deliveryRate
number<double>
openRate
number<double>
clickThroughRate
number<double>
clickToOpenRate
number<double>
unsubscribeRate
number<double>
bounceRate
number<double>
engagementScore
number<double>
collectedAt
string<date-time> | null
lastUpdatedAt
string<date-time> | null
completedAt
string<date-time> | null