API > Campaigns > Get Campaign Report: Unsubscribed

GET https://emailoctopus.com/api/1.2/campaigns/:campaignId/reports/unsubscribed

Get information on the contacts who unsubscribed using a link in the campaign.

Parameters
data (array of structs)

Details of each unsubscribe:

contact (struct)

Details of the contact:

id (string) The identifier of the contact.
email_address (string) The email address of the contact.
first_name (string) The first name of the contact.
last_name (string) The last name of the contact.
subscribed (boolean) The subscribed status of the contact.
deleted (boolean) If the contact has since been deleted.
If `true`, all other fields apart from `id` will be NULL.
created_at (string) When the contact was created, in ISO 8601 format.
occurred_at (string) When the unsubscribe occurred, in ISO 8601 format.
paging (array)

URLs to navigate the results:

next (nullable string) A link for the immediate next page of results.
200 (Success) Returns
data (array of structs)

Details of the contacts that unsubscribed:

id (string) The identifier of the contact.
email_address (string) The email address of the contact.
first_name (string) The first name of the contact.
last_name (string) The last name of the contact.
subscribed (boolean) The subscribed status of the contact.
deleted (boolean) If the contact has since been deleted.
If `true`, all other fields apart from `id` will be NULL.
created_at (string) When the contact was created, in ISO 8601 format.
paging (array)

URLs to navigate the results:

next (nullable string) A link for the immediate next page of results.
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.2/campaigns/00000000-0000-0000-0000-000000000000/reports/unsubscribed?api_key=00000000-0000-0000-0000-000000000000
Example Response
                        
                            {
                                "data": [
                                    {
                                        "contact": {
                                            "id": "00000000-0000-0000-0000-000000000000",
                                            
                                            "email_address": "john.doe@gmail.com",
                                            
                                            "first_name": "John",
                                            "last_name": "Doe",
                                            "subscribed": true,
                                            "created_at": "2017-11-11T15:20:14+00:00"
                                        },
                                        "occurred_at": "2017-11-20T15:20:14+00:00"
                                    },
                                    {
                                        "contact": {
                                            "id": "00000000-0000-0000-0000-000000000001",
                                            
                                            "email_address": "jane.doe@gmail.com",
                                            
                                            "first_name": "Jane",
                                            "last_name": "Doe",
                                            "subscribed": true,
                                            "created_at": "2017-11-12T15:20:14+00:00"
                                        },
                                        "occurred_at": "2017-11-20T15:20:14+00:00"
                                    }
                                ],
                                "paging": {
                                    "next": null,
                                    "previous": null
                                }
                            }