Environments
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
GET | |
GET | |
GET | |
GET | |
POST | |
GET | |
POST | |
GET | |
POST |
Retrieve environments app metrics
Required API key scopes
plugin:readPath parameters
- idinteger
A unique integer value identifying this plugin config.
- 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/.
Example request
GET /api /environments /:project_id /app_metrics /:idExample response
Status 200 No response body
Retrieve environments app metrics
Required API key scopes
plugin:readPath parameters
- idinteger
A unique integer value identifying this plugin config.
- 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/.
Example request
GET /api /environments /:project_id /app_metrics /:idExample response
Status 200 No response body
Retrieve environments app metrics error details
Path parameters
- idinteger
A unique integer value identifying this plugin config.
- 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/.
Example request
GET /api /environments /:project_id /app_metrics /:id /error_detailsExample response
Status 200 No response body
Retrieve environments app metrics error details
Path parameters
- idinteger
A unique integer value identifying this plugin config.
- 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/.
Example request
GET /api /environments /:project_id /app_metrics /:id /error_detailsExample response
Status 200 No response body
Retrieve environments app metrics historical exports
Required API key scopes
plugin:readPath parameters
- plugin_config_idstring
- 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/.
Example request
GET /api /environments /:project_id /app_metrics /:plugin_config_id /historical_exportsExample response
Status 200 No response body
Retrieve environments app metrics historical exports
Required API key scopes
plugin:readPath parameters
- plugin_config_idstring
- 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/.
Example request
GET /api /environments /:project_id /app_metrics /:plugin_config_id /historical_exportsExample 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_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
GET /api /environments /:project_id /app_metrics /:plugin_config_id /historical_exports /:idExample 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_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
GET /api /environments /:project_id /app_metrics /:plugin_config_id /historical_exports /:idExample response
Status 200 No response body
List all environments batch exports
Required API key scopes
batch_export:readPath 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/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET /api /environments /:project_id /batch_exportsExample response
Status 200
List all environments batch exports
Required API key scopes
batch_export:readPath 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/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET /api /environments /:project_id /batch_exportsExample response
Status 200
Create environments batch exports
Required API key scopes
batch_export:writePath 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/.
Request parameters
- namestring
A human-readable name for this BatchExport.
- model
Which model this BatchExport is exporting.
events- Eventspersons- Personssessions- Sessions
- destination
- interval
- pausedboolean
Whether this BatchExport is paused or not.
- last_paused_atstring
The timestamp at which this BatchExport was last paused.
- start_atstring
Time before which any Batch Export runs won't be triggered.
- end_atstring
Time after which any Batch Export runs won't be triggered.
- hogql_querystring
- filters
Response
Example request
POST /api /environments /:project_id /batch_exportsExample response
Status 201
Create environments batch exports
Required API key scopes
batch_export:writePath 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/.
Request parameters
- namestring
A human-readable name for this BatchExport.
- model
Which model this BatchExport is exporting.
events- Eventspersons- Personssessions- Sessions
- destination
- interval
- pausedboolean
Whether this BatchExport is paused or not.
- last_paused_atstring
The timestamp at which this BatchExport was last paused.
- start_atstring
Time before which any Batch Export runs won't be triggered.
- end_atstring
Time after which any Batch Export runs won't be triggered.
- hogql_querystring
- filters
Response
Example request
POST /api /environments /:project_id /batch_exportsExample response
Status 201
List all environments batch exports backfills
ViewSet for BatchExportBackfill models.
Allows creating and reading backfills, but not updating or deleting them.
Required API key scopes
batch_export:readPath parameters
- batch_export_idstring
The BatchExport this backfill belongs to.
- 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/.
Query parameters
- cursorstring
The pagination cursor value.
- orderingstring
Which field to use when ordering the results.
Response
Example request
GET /api /environments /:project_id /batch_exports /:batch_export_id /backfillsExample response
Status 200
List all environments batch exports backfills
ViewSet for BatchExportBackfill models.
Allows creating and reading backfills, but not updating or deleting them.
Required API key scopes
batch_export:readPath parameters
- batch_export_idstring
The BatchExport this backfill belongs to.
- 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/.
Query parameters
- cursorstring
The pagination cursor value.
- orderingstring
Which field to use when ordering the results.
Response
Example request
GET /api /environments /:project_id /batch_exports /:batch_export_id /backfillsExample response
Status 200
Create environments batch exports backfills
Create a new backfill for a BatchExport.
Required API key scopes
batch_export:writePath parameters
- batch_export_idstring
The BatchExport this backfill belongs to.
- 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/.
Request parameters
- start_atstring
The start of the data interval.
- end_atstring
The end of the data interval.
- status
The status of this backfill.
Cancelled- CancelledCompleted- CompletedContinuedAsNew- Continued As NewFailed- FailedFailedRetryable- Failed RetryableTerminated- TerminatedTimedOut- TimedoutRunning- RunningStarting- Starting
- finished_atstring
The timestamp at which this BatchExportBackfill finished, successfully or not.
- teaminteger
The team this belongs to.
- batch_exportstring
The BatchExport this backfill belongs to.
Response
Example request
POST /api /environments /:project_id /batch_exports /:batch_export_id /backfillsExample response
Status 201
Create environments batch exports backfills
Create a new backfill for a BatchExport.
Required API key scopes
batch_export:writePath parameters
- batch_export_idstring
The BatchExport this backfill belongs to.
- 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/.
Request parameters
- start_atstring
The start of the data interval.
- end_atstring
The end of the data interval.
- status
The status of this backfill.
Cancelled- CancelledCompleted- CompletedContinuedAsNew- Continued As NewFailed- FailedFailedRetryable- Failed RetryableTerminated- TerminatedTimedOut- TimedoutRunning- RunningStarting- Starting
- finished_atstring
The timestamp at which this BatchExportBackfill finished, successfully or not.
- teaminteger
The team this belongs to.
- batch_exportstring
The BatchExport this backfill belongs to.
Response
Example request
POST /api /environments /:project_id /batch_exports /:batch_export_id /backfillsExample response
Status 201
Retrieve environments batch exports backfills
ViewSet for BatchExportBackfill models.
Allows creating and reading backfills, but not updating or deleting them.
Required API key scopes
batch_export:readPath parameters
- batch_export_idstring
The BatchExport this backfill belongs to.
- idstring
A UUID string identifying this batch export backfill.
- 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
Example request
GET /api /environments /:project_id /batch_exports /:batch_export_id /backfills /:idExample response
Status 200
Retrieve environments batch exports backfills
ViewSet for BatchExportBackfill models.
Allows creating and reading backfills, but not updating or deleting them.
Required API key scopes
batch_export:readPath parameters
- batch_export_idstring
The BatchExport this backfill belongs to.
- idstring
A UUID string identifying this batch export backfill.
- 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
Example request
GET /api /environments /:project_id /batch_exports /:batch_export_id /backfills /:idExample response
Status 200
Create environments batch exports backfills cancel
Cancel a batch export backfill.
Required API key scopes
batch_export:writePath parameters
- batch_export_idstring
The BatchExport this backfill belongs to.
- idstring
A UUID string identifying this batch export backfill.
- 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/.
Request parameters
- start_atstring
The start of the data interval.
- end_atstring
The end of the data interval.
- status
The status of this backfill.
Cancelled- CancelledCompleted- CompletedContinuedAsNew- Continued As NewFailed- FailedFailedRetryable- Failed RetryableTerminated- TerminatedTimedOut- TimedoutRunning- RunningStarting- Starting
- finished_atstring
The timestamp at which this BatchExportBackfill finished, successfully or not.
- teaminteger
The team this belongs to.
- batch_exportstring
The BatchExport this backfill belongs to.
Example request
POST /api /environments /:project_id /batch_exports /:batch_export_id /backfills /:id /cancelExample response
Status 200 No response body
Create environments batch exports backfills cancel
Cancel a batch export backfill.
Required API key scopes
batch_export:writePath parameters
- batch_export_idstring
The BatchExport this backfill belongs to.
- idstring
A UUID string identifying this batch export backfill.
- 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/.
Request parameters
- start_atstring
The start of the data interval.
- end_atstring
The end of the data interval.
- status
The status of this backfill.
Cancelled- CancelledCompleted- CompletedContinuedAsNew- Continued As NewFailed- FailedFailedRetryable- Failed RetryableTerminated- TerminatedTimedOut- TimedoutRunning- RunningStarting- Starting
- finished_atstring
The timestamp at which this BatchExportBackfill finished, successfully or not.
- teaminteger
The team this belongs to.
- batch_exportstring
The BatchExport this backfill belongs to.
Example request
POST /api /environments /:project_id /batch_exports /:batch_export_id /backfills /:id /cancel