Sign in
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

Changes

Changed in 1 of the 48 revisions of this API.21

  • a0acb3a6a10121See the full diff
    • ▲

      the response property session_id became optional for the status 200

      response-property-became-optional

    • ▲

      response property session_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      added the optional property all_experiments to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog