Skip to main content
POST
Export an environment's traffic

Authorizations

Authorization
string
header
required

Access token issued by WorkOS AuthKit.

Path Parameters

environment_id
string<uuid>
required

Body

application/json
environment_twin_ids
string<uuid>[] | null

Twin slots inside this environment to export, by environment_twins.id. Omitted exports every twin; an empty list would export none, which is never what a caller means.

Minimum array length: 1
occurred_from
string<date-time> | null

Export calls served at or after this instant.

occurred_until
string<date-time> | null

Export calls served at or before this instant. An export never reads past the moment it was asked for, whatever this says.

Response

Successful Response

id
string<uuid>
required
environment_id
string<uuid>
required
status
string
required

pending, running, ready or failed

slice
ExportSlice · object
required

The traffic this export was asked for.

created_at
string<date-time>
required
failure
string | null

Why generation failed, if it did.

completed_at
string<date-time> | null