Get a summary of the campaign.
Parameters | |
---|---|
api_key (string) | Your API key. |
200 (Success) Returns | |||||
---|---|---|---|---|---|
id (string) | The identifier of the campaign. | ||||
sent (int) | The number of contacts that were sent to. | ||||
bounced (struct) |
Statistics related to bounces:
|
||||
opened (struct) |
Statistics related to opens:
|
||||
clicked (struct) |
Statistics related to clicks:
|
||||
complained (int) | The number of contacts who complained. | ||||
unsubscribed (int) | The number of contacts who unsubscribed. |
Non-200 (Error) Returns | ||||
---|---|---|---|---|
Details of the error:
|
Method-specific Error Codes | |
---|---|
CAMPAIGN_NOT_FOUND | The campaign could not be found. |
CAMPAIGN_NOT_SENT | The campaign does not have a status of 'SENT'. |
API-wide Error Codes | |
---|---|
INVALID_PARAMETERS | Parameters are missing or invalid. |
API_KEY_INVALID | Your API key is invalid. |
UNAUTHORISED | You're not authorised to perform that action. |
NOT_FOUND | The requested endpoint does not exist. |
UNKNOWN | An unknown error has occurred. |
Example Request | |
---|---|
/api/1.5/campaigns/00000000-0000-0000-0000-000000000000/reports/summary?api_key=00000000-0000-0000-0000-000000000000 |
Example Response | |
---|---|
|