BUbuttondown
Emails

Retrieve Email Analytics

Changed on

Retrieve analytics for a specific email

get/emails/{id}/analytics

Request

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

Path parameters

idstring required

Response

OK

recipientsinteger

The number of subscribers the email was dispatched to.

attemptsinteger

The number of subscribers handed off to the email provider so far. It rises as the email sends, before deliveries are confirmed.

deliveriesinteger

The number of successful deliveries (recipients minus failures).

opensinteger

The number of unique opens recorded.

clicksinteger

The number of unique link clicks recorded.

temporary_failuresinteger

The number of temporary delivery failures (e.g. soft bounces).

permanent_failuresinteger

The number of permanent delivery failures (e.g. hard bounces).

unsubscriptionsinteger

The number of subscribers who unsubscribed after receiving this email.

complaintsinteger

The number of spam complaints recorded against this email.

survey_responsesinteger

The number of survey responses submitted from this email.

webmentionsinteger

The number of inbound webmentions received for this email.

page_views_lifetimeinteger

The total number of archive page views for this email since publication.

page_views_30integer

The number of archive page views in the last 30 days.

page_views_7integer

The number of archive page views in the last 7 days.

subscriptionsinteger

The number of new subscribers attributed to this email.

paid_subscriptionsinteger

The number of new paid subscribers attributed to this email.

repliesinteger

The number of reply emails received from subscribers.

commentsinteger

The number of comments posted on this email.

social_mentionsinteger

The number of social media mentions of this email.

Changes