Environments
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all environments logs
Required API key scopes
plugin:readPath parameters
- plugin_config_idstring
Query parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
Response
Request
GET 
Response
Status 200
List all environments logs
Required API key scopes
plugin:readPath parameters
- plugin_config_idstring
Query parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
Response
Request
GET 
Response
Status 200
Retrieve environments app metrics
Required API key scopes
plugin:readPath parameters
- idintegerA unique integer value identifying this plugin config. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve environments app metrics
Required API key scopes
plugin:readPath parameters
- idintegerA unique integer value identifying this plugin config. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve environments app metrics error details
Path parameters
- idintegerA unique integer value identifying this plugin config. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve environments app metrics error details
Path parameters
- idintegerA unique integer value identifying this plugin config. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve environments app metrics historical exports
Required API key scopes
plugin:readPath parameters
- plugin_config_idstring
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve environments app metrics historical exports
Required API key scopes
plugin:readPath parameters
- plugin_config_idstring
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve environments app metrics historical exports retrieve
Required API key scopes
plugin:readPath parameters
- idstring
- plugin_config_idstring
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve environments app metrics historical exports retrieve
Required API key scopes
plugin:readPath parameters
- idstring
- plugin_config_idstring
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
List all environments batch exports
Required API key scopes
batch_export:readPath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Query parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
Response
Request
GET 
Response
Status 200
List all environments batch exports
Required API key scopes
batch_export:readPath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Query parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
Response
Request
GET 
Response
Status 200
Create environments batch exports
Required API key scopes
batch_export:writePath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- namestringA human-readable name for this BatchExport. 
- modelWhich model this BatchExport is exporting. - events- Events
- persons- Persons
 
- destination
- interval
- pausedbooleanWhether this BatchExport is paused or not. 
- last_paused_atstringThe timestamp at which this BatchExport was last paused. 
- start_atstringTime before which any Batch Export runs won't be triggered. 
- end_atstringTime after which any Batch Export runs won't be triggered. 
- hogql_querystring
Response
Request
POST 
Response
Status 201
Create environments batch exports
Required API key scopes
batch_export:writePath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- namestringA human-readable name for this BatchExport. 
- modelWhich model this BatchExport is exporting. - events- Events
- persons- Persons
 
- destination
- interval
- pausedbooleanWhether this BatchExport is paused or not. 
- last_paused_atstringThe timestamp at which this BatchExport was last paused. 
- start_atstringTime before which any Batch Export runs won't be triggered. 
- end_atstringTime after which any Batch Export runs won't be triggered. 
- hogql_querystring
Response
Request
POST 
Response
Status 201
List all environments batch exports runs
Required API key scopes
batch_export:readPath parameters
- batch_export_idstringThe BatchExport this run belongs to. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Query parameters
- cursorstringThe pagination cursor value. 
- orderingstringWhich field to use when ordering the results. 
Response
Request
GET 
Response
Status 200
List all environments batch exports runs
Required API key scopes
batch_export:readPath parameters
- batch_export_idstringThe BatchExport this run belongs to. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Query parameters
- cursorstringThe pagination cursor value. 
- orderingstringWhich field to use when ordering the results. 
Response
Request
GET 
Response
Status 200
Retrieve environments batch exports runs
Required API key scopes
batch_export:readPath parameters
- batch_export_idstringThe BatchExport this run belongs to. 
- idstringA UUID string identifying this batch export run. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Response
Request
GET 
Response
Status 200
Retrieve environments batch exports runs
Required API key scopes
batch_export:readPath parameters
- batch_export_idstringThe BatchExport this run belongs to. 
- idstringA UUID string identifying this batch export run. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Response
Request
GET 
Response
Status 200
Create environments batch exports runs cancel
Cancel a batch export run.
Required API key scopes
batch_export:writePath parameters
- batch_export_idstringThe BatchExport this run belongs to. 
- idstringA UUID string identifying this batch export run. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- statusThe status of this run. - Cancelled- Cancelled
- Completed- Completed
- ContinuedAsNew- Continued As New
- Failed- Failed
- FailedRetryable- Failed Retryable
- Terminated- Terminated
- TimedOut- Timedout
- Running- Running
- Starting- Starting
 
- records_completedintegerThe number of records that have been exported. 
- latest_errorstringThe latest error that occurred during this run. 
- data_interval_startstringThe start of the data interval. 
- data_interval_endstringThe end of the data interval. 
- cursorstringAn opaque cursor that may be used to resume. 
- finished_atstringThe timestamp at which this BatchExportRun finished, successfully or not. 
- records_total_countintegerThe total count of records that should be exported in this BatchExportRun. 
Request
POST 
Response
Status 200 No response body
Create environments batch exports runs cancel
Cancel a batch export run.
Required API key scopes
batch_export:writePath parameters
- batch_export_idstringThe BatchExport this run belongs to. 
- idstringA UUID string identifying this batch export run. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- statusThe status of this run. - Cancelled- Cancelled
- Completed- Completed
- ContinuedAsNew- Continued As New
- Failed- Failed
- FailedRetryable- Failed Retryable
- Terminated- Terminated
- TimedOut- Timedout
- Running- Running
- Starting- Starting
 
- records_completedintegerThe number of records that have been exported. 
- latest_errorstringThe latest error that occurred during this run. 
- data_interval_startstringThe start of the data interval. 
- data_interval_endstringThe end of the data interval. 
- cursorstringAn opaque cursor that may be used to resume. 
- finished_atstringThe timestamp at which this BatchExportRun finished, successfully or not. 
- records_total_countintegerThe total count of records that should be exported in this BatchExportRun. 
Request
POST