Buttondown logo

Listing events

The /events endpoint is the programmatic equivalent of the analytics you see in the Buttondown dashboard: every delivery, open, click, unsubscribe, and other interaction is returned as an individual event. Filter by email_id, subscriber_id, automation_id, or event_type to pull exactly the slice you need, and expand the subscriber field to hydrate each event with subscriber details.

For a guided walkthrough of pulling analytics this way, see Retrieving analytics data.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/events"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("GET", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "results": [
        {
            "id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
            "subscriber_id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
            "email_id": null,
            "automation_id": null,
            "creation_date": "2020-09-29T00:00:00+00:00",
            "metadata": {},
            "event_type": "opened",
            "subscriber": null,
            "email": null,
            "automation": null
        }
    ],
    "count": 1
}

Path parameters

Consult the Filtering documentation for more information on how to filter and sort your requests.

event_type

Type
EmailEventType
Description

If provided, only return events of the given type (e.g. delivered, opened, clicked).

ordering

Type
string
Description

The ordering to apply to the results.

Values
  • creation_date
  • -creation_date

expand

Type
array
Description

If provided, expand the given field. (Only supported field: 'subscriber').

email_id

Type
string
Description

If provided, only return events for the given email.

automation_id

Type
string
Description

If provided, only return events for the given automation.

subscriber_id

Type
string
Description

If provided, only return events for the given subscriber.

page_size

Type
string
Description

The number of results per page.

page

Type
string
Description

The page number of the paginated response.