BUbuttondown
Survey Responses

Retrieve Survey Responses

Changed on

List all survey responses

get/survey_responses

Request

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

Query parameters

email_idstring[]

If provided, only return responses submitted from the given email ID(s).

[
  "em_01jv2m9q8r7s6t5w4x3y2z1abc"
]
automation_idstring[]

If provided, only return responses submitted from the given automation ID(s).

[
  "aut_01jv2m9q8r7s6t5w4x3y2z1abc"
]
subscriber_idstring[]

If provided, only return responses made by the given subscriber(s).

[
  "sub_01jv2m9q8r7s6t5w4x3y2z1abc"
]
sourcestring[]

If provided, only return responses submitted from the given arbitrary source string(s).

[
  "landing-page"
]
survey_idstring[]

If provided, only return responses made to the given survey(s).

[
  "srv_01jv2m9q8r7s6t5w4x3y2z1abc"
]
creation_date__startstring date

If provided, only return responses made after the given date.

creation_date__endstring date

If provided, only return responses made before the given date.

expandstring[]

If provided, expand the given field.

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