Exports
Build a CSV or Excel file of sessions or results.
Scope: results:export.
The export object
| Field | Type | |
|---|---|---|
id | string | exp_… |
object | "export" | |
status | string | pending, processing, completed or failed |
livemode | boolean | |
resource | string | results or sessions |
format | string | csv or xlsx |
filters | object | The filters it was built with |
row_count | integer or null | |
error | string or null | |
expires_at | timestamp or null | When the file is deleted, 24 hours after it is ready |
created_at, completed_at | timestamp | |
download_url | string or null | On retrieve only, once completed. Valid for one hour. |
download_url_expires_at | timestamp |
Create an export
POST /exports
| Field | ||
|---|---|---|
resource | optional | results (default) or sessions |
format | optional | csv (default) or xlsx |
interviewer_id | optional | |
status | optional | A session status, including cancelled |
created_gte, created_lt | optional | Date range |
Up to 50,000 rows; above that you get 400 export_too_large. The export builds in the background and fires export.ready when done.
List exports
GET /exports with limit and cursor.
Retrieve an export
GET /exports/{id}. Once status is completed, download_url holds a fresh one-hour link each time you call it. After the file expires, download_url is null and error explains why.