Batch
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
Retrieve batch exports runs
Required API key scopes
batch_export:read
Path parameters
- batch_export_idstring
The BatchExport this run belongs to.
- idstring
A UUID string identifying this batch export run.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200
Create batch exports runs cancel
Cancel a batch export run.
Required API key scopes
batch_export:write
Path parameters
- batch_export_idstring
The BatchExport this run belongs to.
- idstring
A UUID string identifying this batch export run.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve batch exports runs logs
Path parameters
- batch_export_idstring
The BatchExport this run belongs to.
- idstring
A UUID string identifying this batch export run.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Create batch exports runs retry
Retry a batch export run.
We use the same underlying mechanism as when backfilling a batch export, as retrying a run is the same as backfilling one run.
Required API key scopes
batch_export:write
Path parameters
- batch_export_idstring
The BatchExport this run belongs to.
- idstring
A UUID string identifying this batch export run.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve batch exports retrieve
Required API key scopes
batch_export:read
Path parameters
- idstring
A UUID string identifying this batch export.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200
Update batch exports update
Required API key scopes
batch_export:write
Path parameters
- idstring
A UUID string identifying this batch export.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200
Delete batch exports destroy
Required API key scopes
batch_export:write
Path parameters
- idstring
A UUID string identifying this batch export.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 204 No response body
Create batch exports backfill create
Trigger a backfill for a BatchExport.
Note: This endpoint is deprecated. Please use POST /batch_exports/<id>/backfills/ instead.
Required API key scopes
batch_export:write
Path parameters
- idstring
A UUID string identifying this batch export.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve batch exports logs retrieve
Path parameters
- idstring
A UUID string identifying this batch export.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Create batch exports pause create
Pause a BatchExport.
Required API key scopes
batch_export:write
Path parameters
- idstring
A UUID string identifying this batch export.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Create batch exports run test step create
Required API key scopes
INTERNAL
Path parameters
- idstring
A UUID string identifying this batch export.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Create batch exports unpause create
Unpause a BatchExport.
Required API key scopes
batch_export:write
Path parameters
- idstring
A UUID string identifying this batch export.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Create batch exports run test step new create
Required API key scopes
INTERNAL
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve batch exports test retrieve
Required API key scopes
INTERNAL
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.