Guides

Get Statistics Details

Suggest Edits

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

Name In Description Required Type Example
AccountID Path The account guid True Guid A8C062E4-ECFD-48D0-89B1-A37D2622B7A9
CampaignID Path The campaign guid True Guid 77E6A0E6-0C92-4138-89BD-886EDF2ECC0D
Filter Query Filter for email addresses False (default null) String john
IncludeSentItems Query whether to include items that are sent False (default true) Bool True
IncludeDeliveredItems Query whether to include items that are delivered False (default true) Bool True
IncludeOpenedItems Query whether to include items that are opened False (default true) Bool True
IncludeBouncedItems Query whether to include items that are bounced False (default true) Bool True
IncludeComplainedItems Query whether to include items that are complained False (default true) Bool True
IncludeBlacklistedItems Query whether to include items that are blacklisted False (default true) Bool True
IncludeClickedItems Query whether to include items that are clicked False (default true) Bool True
Skip Query The amount of statistics details to skip False (default 0) Int 0
Take Query The amount of statistics details to take False (default 1000) Int 1000
X-CM-PRODUCTTOKEN Header Your product token True Guid C24A5029-37DD-4161-9728-F80D8639588E

Responses

Http status Description
200 Successful operation
400 Bad request 
[
    {
        "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
    }
]