Marketing CampaignsEmail CampaignsEmail Campaign Statistics

Get an email campaign report

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

campaignIdlongRequired
Id of the campaign

Query parameters

statisticsenumOptional

Filter on type of the statistics required. Example globalStats value will only fetch globalStats info of the campaign in returned response.

Allowed values:

Response

Email campaign informations
createdAtstring

Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

footerstring
Footer of the campaign
headerstring
Header of the campaign
htmlContentstring
HTML content of the campaign
idlong
ID of the campaign
modifiedAtstring

UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

namestring
Name of the campaign
recipientsobject
replyTostringformat: "email"
Email defined as the "Reply to" of the campaign
senderobject
statisticsobject
statusenum
Status of the campaign
testSentboolean

Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)

typeenum
Type of campaign
Allowed values:
abTestingboolean or null

Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.

inlineImageActivationboolean or null

Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.

mirrorActiveboolean or null

Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign

previewTextstring or null
Preview text or preheader of the email campaign
recurringboolean or null

FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times

returnBouncelong or null

Total number of non-delivered campaigns for a particular campaign id.

scheduledAtstring or null

UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)

sendAtBestTimeboolean or null
It is true if you have chosen to send your campaign at best time, otherwise it is false
sentDatestring or null

Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if ‘status’ of the campaign is ‘sent’

splitRuleinteger or null

The size of your ab-test groups. Only available if abTesting flag of the campaign is true

subjectstring or null

Subject of the campaign. Only available if abTesting flag of the campaign is false

subjectAstring or null

Subject A of the ab-test campaign. Only available if abTesting flag of the campaign is true

subjectBstring or null

Subject B of the ab-test campaign. Only available if abTesting flag of the campaign is true

tagstring or null
Tag of the campaign
toFieldstring or null
Customisation of the "to" field of the campaign
utmCampaignValuestring or null
utm parameter associated with campaign
utmIDActiveboolean or null
utm id active
utmMediumstring or null
utmSourcestring or null
source of utm
winnerCriteriastring or null

Criteria for the winning version. Only available if abTesting flag of the campaign is true

winnerDelayinteger or null

The duration of the test in hours at the end of which the winning version will be sent. Only available if abTesting flag of the campaign is true

Errors