API referenceStatements

Exports requested

GET
/api/b/v1/statements/exports

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

limit?Limit
Range1 <= value <= 200
Default50
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/statements/exports"
{  "exports": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "string",      "format": "string",      "status": "string",      "filename": "string",      "row_count": 0,      "byte_size": 0,      "error": "string",      "expires_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ]}

Render a period to a file POST

Queue a statement export — AC2. Always 202, never the file: a year of a busy corridor is hundreds of thousands of lines and rendering it inside the request is a gateway timeout for the caller and a held cursor for us. The `export.ready` webhook arrives when it is done, or poll this job. Asking twice for the same period returns the same job, so a dashboard that polls by re-POSTing costs one render rather than one per poll.

One export's progress GET

Next Page