EmailOctopus logo

API > Campaigns > Get Campaign Report: Summary

GET https://emailoctopus.com/api/1.5/campaigns/:campaignId/reports/summary

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:

hard (int) The number of contacts who hard bounced.
soft (int) The number of contacts who soft bounced.
opened (struct)

Statistics related to opens:

total (int) The number of all opens.
unique (int) The number of unique opens.
clicked (struct)

Statistics related to clicks:

total (int) The number of all clicks.
unique (int) The number of unique 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:

code (string) The error code.
message (string) A description 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 
                        
                            {
                            "id": "00000000-0000-0000-0000-000000000000",
                            "sent" : 200,
                            "bounced": {
                                "soft": 10,
                                "hard": 5
                            },
                            "opened": {
                                "total": 110,
                                "unique": 85
                            },
                            "clicked": {
                                "total": 70,
                                "unique": 65
                            },
                            "complained": 50,
                            "unsubscribed": 25
                            }
Code sample
copy
curl -X GET https://emailoctopus.com/api/1.5/campaigns/00000000-0000-0000-0000-000000000000/reports/summary?api_key=00000000-0000-0000-0000-000000000000