Read Campaign Statistics

Tool name: get-campaign-statistics

Reads lifetime statistics for an email or SMS newsletter or follow-up: sends, opens, clicks, conversions, bounces and tracked links. openRate is per send, clickRate per open, and clickRateOfRecipients per send; use these rates rather than dividing the counters. SMS has no opens or browser views; those fields and clickRate are null. Use clickRateOfRecipients for SMS. An unsent campaign has zero counts. Automations use get-automation-statistics.

Input schema

campaignIdinteger, >= 1required

ID of the campaign whose statistics are read

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null

Input example

{
  "campaignId": 1,
  "accountId": null
}

Output schema

campaignIdintegerrequired

namestringrequired

campaignTypestringrequired

channelstringrequired

Enum:"email""sms"

campaignStatusstringrequired

recipientsintegerrequired

sentintegerrequired

failedintegerrequired

opensTotalinteger or nullrequired

opensUniqueinteger or nullrequired

openRatenumber or nullrequired

clicksTotalintegerrequired

clicksUniqueintegerrequired

clickRatenumber or nullrequired

clickRateOfRecipientsnumberrequired

browserViewsTotalinteger or nullrequired

browserViewsUniqueinteger or nullrequired

conversionsTotalintegerrequired

conversionsUniqueintegerrequired

unsubscriptionsintegerrequired

hardBouncesintegerrequired

softBouncesintegerrequired

spamBouncesintegerrequired

spamComplaintsintegerrequired

linksArray of objectsrequired

statisticsUrlstringrequired

Output example

{
  "campaignId": 0,
  "name": "string",
  "campaignType": "string",
  "channel": "email",
  "campaignStatus": "string",
  "recipients": 0,
  "sent": 0,
  "failed": 0,
  "opensTotal": 0,
  "opensUnique": 0,
  "openRate": 0,
  "clicksTotal": 0,
  "clicksUnique": 0,
  "clickRate": 0,
  "clickRateOfRecipients": 0,
  "browserViewsTotal": 0,
  "browserViewsUnique": 0,
  "conversionsTotal": 0,
  "conversionsUnique": 0,
  "unsubscriptions": 0,
  "hardBounces": 0,
  "softBounces": 0,
  "spamBounces": 0,
  "spamComplaints": 0,
  "links": [
    {
      "url": "string",
      "title": "string",
      "clicksTotal": 0,
      "clicksUnique": 0
    }
  ],
  "statisticsUrl": "string"
}