BUbuttondown
Events

Get Event

Changed on

Retrieve a specific event by its ID

get/events/{id}

Request

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

Path parameters

idstring required

Query parameters

expandstring[]

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

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

subscriber_idstring nullable

The ID of the subscriber the event is attributed to, if any.

email_idstring nullable

The ID of the email the event is attributed to, if any.

automation_idstring nullable

The ID of the automation that sent the email, if any.

metadataobject required

Event-type-specific metadata (e.g. clicked URL, bounce reason).

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

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

Example response

{
  "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