Skip to main content
POST
/
export_data
Export data
curl --request POST \
  --url https://api.gumloop.com/api/v1/export_data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "export_fields": [
    "workbook_id"
  ],
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "include_all_workspaces": true,
  "include_personal_workspaces": true,
  "workspace_ids": [
    "<string>"
  ]
}
'
{
  "success": true,
  "data_export_id": "<string>",
  "state": "<string>",
  "created_ts": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
user_id
string
required

The ID of the user requesting the export.

​
export_fields
enum<string>[]
required

Array of fields to include in the export. Not all combinations of selected information are guaranteed to be available.

Available options:
workbook_id,
workbook_name,
workbook_created_ts,
user_id,
user_email,
workspace_id,
workspace_name,
run_id,
credit_cost,
pl_run_created_ts,
pl_run_finished_ts
​
start_date
string<date-time>
required

Start date for the export in YYYY-MM-DDT00:00:00 format (UTC).

​
end_date
string<date-time>
required

End date for the export in YYYY-MM-DDT00:00:00 format (UTC).

​
include_all_workspaces
boolean

Whether to include all workspaces in the organization (default is false). When true, also sets include_personal_workspaces to true.

​
include_personal_workspaces
boolean

Whether to include personal workspaces in the export (default is false). Ignored if 'include_all_workspaces' is set to true.

​
workspace_ids
string[]

An optional array of workspace IDs to include in the export. Ignored if 'include_all_workspaces' is set to true.

Response

Data export successfully initiated

​
success
boolean
​
data_export_id
string

Unique identifier for the data export job. Used to get the data export status and download the completed export.

​
state
string

Current state of the export (e.g., 'PENDING', 'RUNNING').

​
created_ts
string<date-time>

Timestamp when the export was created.