BUbuttondown
Events

List Events

Changed on

List all events

get/events

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/events
  • Auth
    API key in header Authorization

Query parameters

event_type'bounced' | 'clicked' | 'complained' | 'delivered' | 'opened' | 'rejected' | 'replied' | 'unsubscribed'

The type of a subscriber event, such as a delivery, open, click, or reply.

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

ordering'creation_date' | '-creation_date'

The ordering to apply to the results.

expandstring[]

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

email_idstring

If provided, only return events for the given email.

automation_idstring

If provided, only return events for the given automation.

subscriber_idstring

If provided, only return events for the given subscriber.

page_sizeinteger

The number of results per page.

pageinteger

The page number of the paginated response.

Example:1

Response

OK

nextstring nullable

The URL to the next page of results, if any.

previousstring nullable

The URL to the previous page of results, if any.

countinteger required

The total number of results across all pages.

Example response

{
  "results": [
    {
      "subscriber": {
        "country": "US",
        "email_address": "telemachus@buttondown.email",
        "delivered_count": 12,
        "open_count": 7,
        "clicked_count": 3,
        "open_rate": 0.5833,
        "click_rate": 0.25
      },
      "email": {
        "slug": "welcome-to-the-newsletter"
      }
    }
  ]
}

Changes

  • 594190e20eb7Revision changes
    • warning

      added the new comment_text_contains_link enum value to the ////// response property for the response status

  • 9d2fc1dfd458Revision changes
    • warning

      added the new stripe.charge.succeeded enum value to the //// response property for the response status