Environments-3
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
POST | |
POST | |
POST | |
GET | |
GET | |
POST | |
GET | |
POST |
Retrieve environments batch exports logs
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/.
Example request
GET
/api /environments /:project_id /batch_exports /:id /logs
Example response
Status 200 No response body
Retrieve environments batch exports logs
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/.
Example request
GET
/api /environments /:project_id /batch_exports /:id /logs
Example response
Status 200 No response body
Create environments batch exports pause
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/.
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
Example request
POST
/api /environments /:project_id /batch_exports /:id /pause
Example response
Status 200 No response body
Create environments batch exports pause
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/.
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
Example request
POST
/api /environments /:project_id /batch_exports /:id /pause
Example response
Status 200 No response body
Create environments batch exports run test step
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/.
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
Example request
POST
/api /environments /:project_id /batch_exports /:id /run_test_step
Example response
Status 200 No response body
Create environments batch exports run test step
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/.
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
Example request
POST
/api /environments /:project_id /batch_exports /:id /run_test_step
Example response
Status 200 No response body
Create environments batch exports unpause
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/.
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
Example request
POST
/api /environments /:project_id /batch_exports /:id /unpause
Example response
Status 200 No response body
Create environments batch exports unpause
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/.
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
Example request
POST
/api /environments /:project_id /batch_exports /:id /unpause
Example response
Status 200 No response body
Create environments batch exports run test step new
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/.
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
Example request
POST
/api /environments /:project_id /batch_exports /run_test_step_new
Example response
Status 200 No response body
Create environments batch exports run test step new
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/.
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
Example request
POST
/api /environments /:project_id /batch_exports /run_test_step_new
Example response
Status 200 No response body
Retrieve environments batch exports test
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/.
Example request
GET
/api /environments /:project_id /batch_exports /test
Example response
Status 200 No response body
Retrieve environments batch exports test
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/.
Example request
GET
/api /environments /:project_id /batch_exports /test
Example response
Status 200 No response body
List all environments dashboards
Required API key scopes
dashboard:read
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/.
Query parameters
- formatstringOne of:
"json"
"txt"
- 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 /dashboards
Example response
Status 200
List all environments dashboards
Required API key scopes
dashboard:read
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/.
Query parameters
- formatstringOne of:
"json"
"txt"
- 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 /dashboards
Example response
Status 200
Create environments dashboards
Required API key scopes
dashboard:write
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/.
Query parameters
- formatstringOne of:
"json"
"txt"
Request parameters
- namestring
- descriptionstring
- pinnedboolean
- last_accessed_atstring
- deletedboolean
- breakdown_colors
- data_color_theme_idinteger
- tagsarray
- restriction_level
- last_refreshstring
- use_templatestring
- use_dashboardinteger
- delete_insightsbooleanDefault:
false
- _create_in_folderstring
Response
Example request
POST
/api /environments /:project_id /dashboards
Example response
Status 201
Create environments dashboards
Required API key scopes
dashboard:write
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/.
Query parameters
- formatstringOne of:
"json"
"txt"
Request parameters
- namestring
- descriptionstring
- pinnedboolean
- last_accessed_atstring
- deletedboolean
- breakdown_colors
- data_color_theme_idinteger
- tagsarray
- restriction_level
- last_refreshstring
- use_templatestring
- use_dashboardinteger
- delete_insightsbooleanDefault:
false
- _create_in_folderstring
Response
Example request
POST
/api /environments /:project_id /dashboards
Example response
Status 201
List all environments dashboards collaborators
Required API key scopes
dashboard:read
Path parameters
- dashboard_idinteger
- 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 /dashboards /:dashboard_id /collaborators
Example response
Status 200
List all environments dashboards collaborators
Required API key scopes
dashboard:read
Path parameters
- dashboard_idinteger
- 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 /dashboards /:dashboard_id /collaborators
Example response
Status 200
Create environments dashboards collaborators
Required API key scopes
dashboard:write
Path parameters
- dashboard_idinteger
- 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
- level
- user_uuidstring
Response
Example request
POST
/api /environments /:project_id /dashboards /:dashboard_id /collaborators
Example response
Status 201
Create environments dashboards collaborators
Required API key scopes
dashboard:write
Path parameters
- dashboard_idinteger
- 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
- level
- user_uuidstring
Response
Example request
POST
/api /environments /:project_id /dashboards /:dashboard_id /collaborators