EmailOctopus logo

API > Campaigns > Get Campaign Report: Opened

GET https://emailoctopus.com/api/1.6/campaigns/:campaignId/reports/opened

Get information on the contacts who opened the campaign.

Parameters
api_key (string) Your API key.
limit (integer) The number of records to return per page, up to a maximum of 100. Defaults to 100.
200 (success) returns
data (array of structs)

Details of each open:

contact (struct)

Details of the contact:

id (string) The identifier of the contact.
email_address (string) The email address of the contact.
fields (object) An object containing key/value pairs of field values, using the field's tag as the key.
tags (array) An array of tags associated with the contact.
status (string) The status of the contact: SUBSCRIBED, UNSUBSCRIBED or PENDING.
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.
last_updated_at (string) When the contact was last updated, in ISO 8601 format.
occurred_at (string) When the open occurred, in ISO 8601 format.
paging (struct/array)

If there is more data available, an object is returned in the following format:

next (string) A link for the immediate next page of results.

If there is no more data to page, an empty array is returned.

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'.
CAMPAIGN_FEATURE_DISABLED The campaign does not have open tracking enabled.
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.6/campaigns/00000000-0000-0000-0000-000000000000/reports/opened?api_key=00000000-0000-0000-0000-000000000000
Example response
{
    "data": [
        {
            "contact": {
                "id": "00000000-0000-0000-0000-000000000000",
                "email_address": "john.doe@example.com",
                "fields": {
                    "FirstName": "John",
                    "LastName": "Doe",
                    "Birthday": "2000-12-20"
                },
                "tags": [
                    "vip"
                ],
                "status": "SUBSCRIBED",
                "created_at": "2025-07-14T00:00:00+00:00",
                "last_updated_at": "2025-07-15T23:41:33+00:00"
            },
            "occurred_at": "2025-07-14T23:41:33+00:00"
        },
        {
            "contact": {
                "id": "00000000-0000-0000-0000-000000000001",
                "email_address": "jane.doe@example.com",
                "fields": {
                    "FirstName": "Jane",
                    "LastName": "Doe",
                    "Birthday": "2000-12-20"
                },
                "tags": [
                    "vip"
                ],
                "status": "SUBSCRIBED",
                "created_at": "2025-07-14T00:00:00+00:00"
            },
            "occurred_at": "2025-07-14T23:41:33+00:00"
        }
    ],
    "paging": []
}
Code sample
copy