CampaignStats.Get

Description

Retrieves the statistics (subscribers opened, subscribers clicked) from a campaign.

Request Parameters

SessionID = {string} (required)
Session ID which is needed to authenticate the access. It's optional and required for desktop applications only.
Command = {CampaignStats.Get} (required)
API Command.
StatisticsType = {string} (required)
The type of statistics to be returned. It should be SubscribersOpened or SubscribersClicked.
ResponseFormat = {JSON | XML} (required)
Response format.
JSONPCallBack = {bool}
Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP.
CampaignID = {integer} (required)
ID of the campaign to fetch the stats from.
PaginateFrom = {integer} (optional)
Pagination starts from 0.
TotalSend will always return 25 rows of data by default.

Response Parameters

Success = {true | false}
States if there is an error or not.
ErrorCode = {integer}
If there is an error, error's code.
ErrorText = {text}
 The description of the error that occurred.
Campaign = {array}
 
Campaign information
 

 

Error Codes

1
Missing Campaign ID.
2
Missing statistics type.
99998
Authentication failure or session expired.
99999
Not enough privileges.