Buttondown logo

Creating an export

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/exports"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "collections": [
    "subscribers"
  ],
  "parameters": {
    "status": "active"
  },
  "format": "csv",
  "columns": [
    "id",
    "email"
  ]
}

response = requests.request("POST", url, headers=headers, json=data)
print(response.text)

Sample responses

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

{
    "id": "exp_29fxqcmrkp969vzttksexvmvr8",
    "creation_date": "2019-08-24T14:15:22",
    "collections": [
        "subscribers"
    ],
    "parameters": null,
    "format": "csv",
    "columns": null,
    "url": "https://s3.amazonaws.com/buttondown-exports/basic-export.csv",
    "completion_date": "2019-08-24T15:15:22",
    "status": "ready"
}

Body parameters

All parameters are optional unless explicitly specified.

collectionsstring[] · enum · required

The collections of objects to export.

example
[ "subscribers" ]
values
  • subscribers
  • emails
  • events
  • referrals
  • surveys
  • comments
  • requests
  • mentions
  • conversations
  • images
  • stripe_subscriptions
  • stripe_products
  • stripe_customers
  • stripe_prices
  • stripe_charges

parametersobject

Parameters to pass to the exporter. These are specific to the collection and format, and constrain the export.

example
{ "status": "active" }

formatstring · enum

The format of the export files.

example
"csv"
values
  • csv

    Comma-separated values.

  • json

    JavaScript Object Notation.

columnsarray

If provided, the export will only include these columns.

example
[ "id", "email" ]