Skip to main content

Get statistics details

Get detailed statistics per recipient of a campaign

GET https://api.cm.com/bulkemail/v1.0/accounts/{accountID}/campaigns/{campaignID}/statistics/details

GET Parameters​

NameInDescriptionRequiredTypeExample
AccountIDPathThe account guidTrueGuidA8C062E4-ECFD-48D0-89B1-A37D2622B7A9
CampaignIDPathThe campaign guidTrueGuid77E6A0E6-0C92-4138-89BD-886EDF2ECC0D
FilterQueryFilter for email addressesFalse (default null)Stringjohn
IncludeSentItemsQuerywhether to include items that are sentFalse (default true)BoolTrue
IncludeDeliveredItemsQuerywhether to include items that are deliveredFalse (default true)BoolTrue
IncludeOpenedItemsQuerywhether to include items that are openedFalse (default true)BoolTrue
IncludeBouncedItemsQuerywhether to include items that are bouncedFalse (default true)BoolTrue
IncludeComplainedItemsQuerywhether to include items that are complainedFalse (default true)BoolTrue
IncludeBlacklistedItemsQuerywhether to include items that are blacklistedFalse (default true)BoolTrue
IncludeClickedItemsQuerywhether to include items that are clickedFalse (default true)BoolTrue
SkipQueryThe amount of statistics details to skipFalse (default 0)Int0
TakeQueryThe amount of statistics details to takeFalse (default 1000)Int1000
X-CM-PRODUCTTOKENHeaderYour product tokenTrueGuidC24A5029-37DD-4161-9728-F80D8639588E

Responses​

Http statusDescription
200Successful operation
400Bad request
Example response
[
{
"EmailAddress": "[email protected]",
"SentOn": "2017-08-09T13:07:33.12",
"SentOnUtc": "2017-08-09T12:07:33.12Z",
"DeliveredOn": "2017-08-09T13:07:33.13",
"DeliveredOnUtc": "2017-08-09T12:07:33.13Z",
"OpenedOn": null,
"OpenedOnUtc": null,
"BouncedOn": null,
"BouncedOnUtc": null,
"ComplainedOn": null,
"ComplainedOnUtc": null,
"UnsubscribedOn": null,
"UnsubscribedOnUtc": null,
"BlacklistedOn": null,
"BlacklistedOnUtc": null,
"NumberOfClicks": 0
}
]