Batch exports
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
GET | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
POST | |
POST | |
POST | |
GET | |
GET | |
POST |
List all batch exports
Required API key scopes
batch_export:readPath parameters
- project_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:project_id /batch_exportsExample response
Status 200
RESPONSE
Create batch exports
Required API key scopes
batch_export:writePath parameters
- project_idstring
Request parameters
- namestring
- model
- destination
- interval
- pausedboolean
- last_paused_atstring
- start_atstring
- end_atstring
- hogql_querystring
- filters
- timezone
- offset_dayinteger
- offset_hourinteger
Response
Example request
POST /api /environments /:project_id /batch_exportsExample response
Status 201
RESPONSE
List all batch exports runs
Required API key scopes
batch_export:readPath parameters
- batch_export_idstring
- project_idstring
Query parameters
- cursorstring
- orderingstring
Response
Example request
GET /api /environments /:project_id /batch_exports /:batch_export_id /runsExample response
Status 200
RESPONSE
Retrieve batch exports runs
Required API key scopes
batch_export:readPath parameters
- batch_export_idstring
- idstring
- project_idstring
Response
Example request
GET /api /environments /:project_id /batch_exports /:batch_export_id /runs /:idExample response
Status 200
RESPONSE
Create batch exports runs cancel
Cancel a batch export run.
Required API key scopes
batch_export:writePath parameters
- batch_export_idstring
- idstring
- project_idstring
Request parameters
- status
- records_completedinteger
- latest_errorstring
- data_interval_startstring
- data_interval_endstring
- cursorstring
- finished_atstring
- records_total_countinteger
- bytes_exportedinteger
- backfillstring
Example request
POST /api /environments /:project_id /batch_exports /:batch_export_id /runs /:id /cancelExample response
Status 200 No response body
Retrieve batch exports runs logs
Path parameters
- batch_export_idstring
- idstring
- project_idstring
Example request
GET /api /environments /:project_id /batch_exports /:batch_export_id /runs /:id /logsExample 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:writePath parameters
- batch_export_idstring
- idstring
- project_idstring
Request parameters
- status
- records_completedinteger
- latest_errorstring
- data_interval_startstring
- data_interval_endstring
- cursorstring
- finished_atstring
- records_total_countinteger
- bytes_exportedinteger
- backfillstring
Example request
POST /api /environments /:project_id /batch_exports /:batch_export_id /runs /:id /retryExample response
Status 200 No response body
Retrieve batch exports
Required API key scopes
batch_export:readPath parameters
- idstring
- project_idstring
Response
Example request
GET /api /environments /:project_id /batch_exports /:idExample response
Status 200
RESPONSE
Update batch exports
Required API key scopes
batch_export:writePath parameters
- idstring
- project_idstring
Request parameters
- namestring
- model
- destination
- interval
- pausedboolean
- last_paused_atstring
- start_atstring
- end_atstring
- hogql_querystring
- filters
- timezone
- offset_dayinteger
- offset_hourinteger
Response
Example request
PATCH /api /environments /:project_id /batch_exports /:idExample response
Status 200
RESPONSE
Delete batch exports
Required API key scopes
batch_export:writePath parameters
- idstring
- project_idstring
Example request
DELETE /api /environments /:project_id /batch_exports /:idExample response
Status 204 No response body
Retrieve batch exports logs
Path parameters
- idstring
- project_idstring
Example request
GET /api /environments /:project_id /batch_exports /:id /logsExample response
Status 200 No response body
Create batch exports pause
Pause a BatchExport.
Required API key scopes
batch_export:writePath parameters
- idstring
- project_idstring
Request parameters
- namestring
- model
- destination
- interval
- pausedboolean
- last_paused_atstring
- start_atstring
- end_atstring
- hogql_querystring
- filters
- timezone
- offset_dayinteger
- offset_hourinteger
Example request
POST /api /environments /:project_id /batch_exports /:id /pauseExample response
Status 200 No response body
Create batch exports run test step
Required API key scopes
INTERNALPath parameters
- idstring
- project_idstring
Request parameters
- namestring
- model
- destination
- interval
- pausedboolean
- last_paused_atstring
- start_atstring
- end_atstring
- hogql_querystring
- filters
- timezone
- offset_dayinteger
- offset_hourinteger
Example request
POST /api /environments /:project_id /batch_exports /:id /run_test_stepExample response
Status 200 No response body
Create batch exports unpause
Unpause a BatchExport.
Required API key scopes
batch_export:writePath parameters
- idstring
- project_idstring
Request parameters
- namestring
- model
- destination
- interval
- pausedboolean
- last_paused_atstring
- start_atstring
- end_atstring
- hogql_querystring
- filters
- timezone
- offset_dayinteger
- offset_hourinteger
Example request
POST /api /environments /:project_id /batch_exports /:id /unpauseExample response
Status 200 No response body
Create batch exports run test step new
Required API key scopes
INTERNALPath parameters
- project_idstring
Request parameters
- namestring
- model
- destination
- interval
- pausedboolean
- last_paused_atstring
- start_atstring
- end_atstring
- hogql_querystring
- filters
- timezone
- offset_dayinteger
- offset_hourinteger
Example request
POST /api /environments /:project_id /batch_exports /run_test_step_newExample response
Status 200 No response body
Retrieve batch exports test
Required API key scopes
INTERNALPath parameters
- project_idstring
Example request
GET /api /environments /:project_id /batch_exports /testExample response
Status 200 No response body
List all batch exports list
Required API key scopes
batch_export:readPath parameters
- organization_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /organizations /:organization_id /batch_exportsExample response
Status 200
RESPONSE
List all batch exports list
Required API key scopes
batch_export:readPath parameters
- organization_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /organizations /:organization_id /batch_exportsExample response
Status 200
RESPONSE
Create batch exports create
Required API key scopes
batch_export:writePath parameters
- organization_idstring
Request parameters
- namestring
- model
- destination
- interval
- pausedboolean
- last_paused_atstring
- start_atstring
- end_atstring
- hogql_querystring
- filters
- timezone
- offset_dayinteger
- offset_hourinteger
Response
Example request
POST /api /organizations /:organization_id /batch_exportsExample response
Status 201
RESPONSE