Skip to content

export_project

Queue a portable .btx archive export for a Bridge Town project. Returns job_id and status; poll get_export(job_id) for completion and the pre-signed download URL.

NameTypeRequiredDefaultDescription
project_idstrYes
include_runsintNo5
include_dashboardsboolNoTrue

Returns a structured object. Top-level fields:

  • job_id (string)
  • status (string)
  • project_id (string)
  • message (string)
  • warning (null)

See the response example below for the full payload shape.

{
"name": "export_project",
"arguments": {
"project_id": "forecasts",
"include_runs": 5,
"include_dashboards": true
}
}
{
"job_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"status": "queued",
"project_id": "forecasts",
"message": "Export queued.",
"warning": null
}
  • Module: Exports
  • Requires authentication via API token or Auth0 JWT.