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:
excludeHtmlContentbooleanOptional

Use this flag to exclude htmlContent from the response body. If set to true, htmlContent field will be returned as empty string in the response body

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

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

attachmentFilestring
Url of the attachment file. Only available if the campaign has an attachment.
inlineImageActivationboolean

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

mirrorActiveboolean

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

previewTextstring
Preview text or preheader of the email campaign
recurringboolean

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

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

scheduledAtstring

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

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

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

splitRuleinteger

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

subjectstring

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

subjectAstring

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

subjectBstring

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

tagstring
Tag of the campaign
tagslist of strings
List of tags of the campaign
toFieldstring
Customisation of the "to" field of the campaign
utmCampaignValuestring
utm parameter associated with campaign
utmIDActiveboolean
utm id active
utmMediumstring
utmSourcestring
source of utm
winnerCriteriastring

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

winnerDelayinteger

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

400
Bad Request Error
404
Not Found Error