Analytics summary
Counts for the snapshot taken at send. dailyLimit is the channel tier, not a campaign setting. Rates are fractions from 0 to 1.
bearerAuthorizationBearer <token>Key issued in Settings → Developer → API key. Inbox methods need the Inbox scope. Campaigns methods need the Campaigns scope.
campaignId*stringCampaign id returned by create or list.
application/json- response
campaignId*stringCampaign id.
status*stringCampaign status.
"draft""sending""pause""completed""failed""scheduled"recipients*numberRecipients in the send snapshot.
sent*numberRecipients whose status is sent, delivered, or read.
delivered*numberRecipients whose status is delivered or read.
read*numberRecipients whose status is read.
failed*numberRecipients whose status is failed.
skipped*numberRecipients whose status is skipped.
cancelled*numberRecipients removed from the queue before send.
queued*numberRecipients whose status is queued or leasing.
replied*numberRecipients who sent at least one reply.
textReplies*numberRecipients who sent at least one text reply.
clicks*numberButton replies in the snapshot.
uniqueClicks*numberRecipients who clicked at least one button.
rates*Shares of recipients, from 0 to 1, rounded to 4 decimal places. Each rate is 0 when there are no recipients.
buttons*array<>Button clicks grouped by button id.
queuedRemaining*numberRecipients still waiting to be sent.
sentThisPortion*numberTemplate sends already started in the current tier window.
dailyLimit*|How many template sends this channel may start in a rolling 24 hours, or null when the tier is unknown or unlimited.
nextPortionAt*|When the next template portion can start, or null when a portion is not waiting.
date-timecurl -X GET 'https://api.1msg.io/api/v1/campaigns/string/analytics'{ "campaignId": "cm3campaign01", "status": "draft", "recipients": 12, "sent": 10, "delivered": 8, "read": 4, "failed": 1, "skipped": 1, "cancelled": 0, "queued": 0, "replied": 2, "textReplies": 1, "clicks": 3, "uniqueClicks": 2, "rates": { "sent": 0.5, "delivery": 0.4, "read": 0.25, "reply": 0.1, "click": 0.05, "failed": 0 }, "buttons": [ { "id": "shop", "title": "Shop", "clicks": 4, "uniqueClicks": 3 } ], "queuedRemaining": 0, "sentThisPortion": 0, "dailyLimit": 1000, "nextPortionAt": null}