Data Exports

Create data export

Changed on

Adds an S3, Google Cloud Storage or S3-compatible bucket as a data export destination. Sequenzy first writes a small test file under the path prefix; the request fails with 400 when that write fails. The first export starts immediately and later exports follow the frequency. Requires data_exports:write, subscribers:read and analytics:read.

post/data-exports

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/data-exports
  • Auth
    HTTP bearer

Request body

namestring required
provider's3' | 'gcs' required

s3 for Amazon S3 or any S3-compatible service; gcs for Google Cloud Storage (HMAC keys).

bucketstring required

Bucket name, not a URL.

regionstring nullable

Bucket region. Required for Amazon S3 without a custom endpoint; defaults to auto otherwise.

endpointstring nullable

HTTPS origin of an S3-compatible service (R2, MinIO, Backblaze). Must resolve to a public address. Not allowed for gcs.

pathPrefixstring nullable

Folder inside the bucket. Leading and trailing slashes are removed.

accessKeyIdstring required

Access key ID (GCS HMAC access ID).

secretAccessKeystring required

Secret access key. Stored encrypted and never returned.

datasetsstring[]
frequency'every_5_minutes' | 'every_15_minutes' | 'hourly' | 'daily'
startFromstring date-time nullable

Include events recorded since this time, at most 30 days ago. Defaults to now.

Response

Data export created and first run queued

successboolean

Example response

{
  "success": true
}

Changes