Analytics

Get channel performance analytics

Returns aggregate delivery metrics plus unique-message email Open and Click rates over the selected date range.

GET
/v1/analytics/channel-stats

Returns aggregate delivery metrics plus unique-message email Open and Click rates over the selected date range. sent counts every outbound message accepted in the range; each rate is taken over the messages the channel actually attempted, so one still waiting to be sent neither helps nor hurts it. Each engagement rate uses the corresponding tracking-eligible delivered-message cohort; repeated provider observations do not inflate the numerator.

x-api-key<token>

In: header

Query Parameters

startDate?|null
endDate?|null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/analytics/channel-stats"
{  "email": {    "sent": 0,    "deliveryRate": 0,    "uniqueOpenedMessages": 0,    "openTrackingEligibleDeliveredMessages": 0,    "uniqueMessageOpenRate": 0,    "uniqueClickedMessages": 0,    "clickTrackingEligibleDeliveredMessages": 0,    "uniqueMessageClickRate": 0,    "bounceRate": 0  }}