Sign in

v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-275867561.6 MB
bulk-exports

Cancel Bulk Export

Cancel a bulk export by ID

patch/api/v1/bulk-exports/{bulk_export_id}

Path parameters

bulk_export_idstring uuid required

Request body

status'Cancelled'

Response

Successful Response

bulk_export_destination_idstring uuid required
session_idstring uuid nullable
all_experimentsboolean
start_timestring date-time required
end_timestring date-time nullable
filterstring nullable
format'Parquet'
format_version'v1' | 'v2_beta'

Enum for bulk export format versions.

compression'none' | 'gzip' | 'snappy' | 'zstandard'
interval_hoursinteger nullable
export_fieldsstring[] nullable
idstring uuid required
tenant_idstring uuid required
status'Cancelled' | 'Completed' | 'Created' | 'IntervalScheduled' | 'Failed' | 'TimedOut' | 'Running' required
created_atstring date-time required
updated_atstring date-time required
finished_atstring date-time nullable required
source_bulk_export_idstring uuid nullable