MailcrateDocs
Campaigns

Get campaign stats

GET
/public/campaign/{id}/stats

Requires the campaign:read scope.

Authorization

ApiKey
headerAuthorization<token>

Api-Key mc_... — a workspace API key.

Path Parameters

id*string

Response Body

application/json
  1. response
totalRecipients*number
sentCount*number
deliveredCount*number
bouncedCount*number
openedCount*number
clickedCount*number
complainedCount*number
unconfirmedCount*number
frequencyCapSkippedCount*number
Example Request
curl -X GET 'https://api.mailcrate.io/public/campaign/string/stats' \  -H 'Authorization: Api-Key <api_key>'
Example Response
{  "totalRecipients": 0,  "sentCount": 0,  "deliveredCount": 0,  "bouncedCount": 0,  "openedCount": 0,  "clickedCount": 0,  "complainedCount": 0,  "unconfirmedCount": 0,  "frequencyCapSkippedCount": 0}

Get a local-time release schedule GET

For a campaign sent in each recipient's local time: one line per release instant. Empty for other campaigns. Requires the `campaign:read` scope.

List campaigns GET

Requires the `campaign:read` scope.