Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaignKey}
/
report
/
timeline
Get the statistics timeline
curl --request GET \
  --url https://api.railmail.app/api/v1/campaigns/{campaignKey}/report/timeline \
  --header 'X-API-Key: <api-key>'
[
  {
    "timestamp": "2023-11-07T05:31:56Z",
    "sent": 123,
    "delivered": 123,
    "opened": 123,
    "clicked": 123,
    "bounced": 123
  }
]

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

Timeline points

timestamp
string<date-time>
sent
integer<int64>
delivered
integer<int64>
opened
integer<int64>
clicked
integer<int64>
bounced
integer<int64>