Batch
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
PATCH | |
DELETE | |
GET | |
POST | |
POST | |
POST | |
POST | |
GET | |
GET |
Update environments batch exports
Required API key scopes
batch_export:writePath parameters
- environment_idstring
- 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 /:environment_id /batch_exports /:idExample response
Status 200
RESPONSE
Update environments batch exports
Required API key scopes
batch_export:writePath parameters
- environment_idstring
- 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 /:environment_id /batch_exports /:idExample response
Status 200
RESPONSE
Delete environments batch exports
Required API key scopes
batch_export:writePath parameters
- environment_idstring
- idstring
Example request
DELETE /api /environments /:environment_id /batch_exports /:idExample response
Status 204 No response body
Delete environments batch exports
Required API key scopes
batch_export:writePath parameters
- environment_idstring
- idstring
Example request
DELETE /api /environments /:environment_id /batch_exports /:idExample response
Status 204 No response body
Retrieve environments batch exports logs
Path parameters
- environment_idstring
- idstring
Example request
GET /api /environments /:environment_id /batch_exports /:id /logsExample response
Status 200 No response body
Retrieve environments batch exports logs
Path parameters
- environment_idstring
- idstring
Example request
GET /api /environments /:environment_id /batch_exports /:id /logsExample response
Status 200 No response body
Create environments batch exports pause
Pause a BatchExport.
Required API key scopes
batch_export:writePath parameters
- environment_idstring
- 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 /:environment_id /batch_exports /:id /pauseExample response
Status 200 No response body
Create environments batch exports pause
Pause a BatchExport.
Required API key scopes
batch_export:writePath parameters
- environment_idstring
- 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 /:environment_id /batch_exports /:id /pauseExample response
Status 200 No response body
Create environments batch exports run test step
Required API key scopes
INTERNALPath parameters
- environment_idstring
- 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 /:environment_id /batch_exports /:id /run_test_stepExample response
Status 200 No response body
Create environments batch exports run test step
Required API key scopes
INTERNALPath parameters
- environment_idstring
- 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 /:environment_id /batch_exports /:id /run_test_stepExample response
Status 200 No response body
Create environments batch exports unpause
Unpause a BatchExport.
Required API key scopes
batch_export:writePath parameters
- environment_idstring
- 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 /:environment_id /batch_exports /:id /unpauseExample response
Status 200 No response body
Create environments batch exports unpause
Unpause a BatchExport.
Required API key scopes
batch_export:writePath parameters
- environment_idstring
- 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 /:environment_id /batch_exports /:id /unpauseExample response
Status 200 No response body
Create environments batch exports run test step new
Required API key scopes
INTERNALPath parameters
- environment_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 /:environment_id /batch_exports /run_test_step_newExample response
Status 200 No response body
Create environments batch exports run test step new
Required API key scopes
INTERNALPath parameters
- environment_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 /:environment_id /batch_exports /run_test_step_newExample response
Status 200 No response body
Retrieve environments batch exports test
Required API key scopes
INTERNALPath parameters
- environment_idstring
Example request
GET /api /environments /:environment_id /batch_exports /testExample response
Status 200 No response body
Retrieve environments batch exports test
Required API key scopes
INTERNALPath parameters
- environment_idstring
Example request
GET /api /environments /:environment_id /batch_exports /testExample response
Status 200 No response body
List all batch exports
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
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