Environments-16
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
POST | |
POST | |
GET | |
GET | |
GET | |
GET | |
GET | |
PATCH | |
GET | |
POST | |
GET |
Create environments hog functions broadcast
Path parameters
- idstring
A UUID string identifying this hog function.
- 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
- type
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
- _create_in_folderstring
Example request
POST
/api /environments /:project_id /hog_functions /:id /broadcast
Example response
Status 200 No response body
Create environments hog functions invocations
Path parameters
- idstring
A UUID string identifying this hog function.
- 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
- type
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
- _create_in_folderstring
Example request
POST
/api /environments /:project_id /hog_functions /:id /invocations
Example response
Status 200 No response body
Create environments hog functions invocations
Path parameters
- idstring
A UUID string identifying this hog function.
- 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
- type
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
- _create_in_folderstring
Example request
POST
/api /environments /:project_id /hog_functions /:id /invocations
Example response
Status 200 No response body
Retrieve environments hog functions logs
Path parameters
- idstring
A UUID string identifying this hog function.
- 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 /hog_functions /:id /logs
Example response
Status 200 No response body
Retrieve environments hog functions logs
Path parameters
- idstring
A UUID string identifying this hog function.
- 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 /hog_functions /:id /logs
Example response
Status 200 No response body
Retrieve environments hog functions metrics
Path parameters
- idstring
A UUID string identifying this hog function.
- 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 /hog_functions /:id /metrics
Example response
Status 200 No response body
Retrieve environments hog functions metrics
Path parameters
- idstring
A UUID string identifying this hog function.
- 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 /hog_functions /:id /metrics
Example response
Status 200 No response body
Retrieve environments hog functions metrics totals
Path parameters
- idstring
A UUID string identifying this hog function.
- 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 /hog_functions /:id /metrics /totals
Example response
Status 200 No response body
Retrieve environments hog functions metrics totals
Path parameters
- idstring
A UUID string identifying this hog function.
- 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 /hog_functions /:id /metrics /totals
Example response
Status 200 No response body
Retrieve environments hog functions icon
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 /hog_functions /icon
Example response
Status 200 No response body
Retrieve environments hog functions icon
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 /hog_functions /icon
Example response
Status 200 No response body
Retrieve environments hog functions icons
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 /hog_functions /icons
Example response
Status 200 No response body
Retrieve environments hog functions icons
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 /hog_functions /icons
Example response
Status 200 No response body
Update environments hog functions rearrange
Update the execution order of multiple HogFunctions.
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
- type
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
- _create_in_folderstring
Example request
PATCH
/api /environments /:project_id /hog_functions /rearrange
Example response
Status 200 No response body
Update environments hog functions rearrange
Update the execution order of multiple HogFunctions.
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
- type
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
- _create_in_folderstring
Example request
PATCH
/api /environments /:project_id /hog_functions /rearrange
Example response
Status 200 No response body
List all environments insights
Required API key scopes
insight: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
- basicboolean
Return basic insight metadata only (no results, faster).
- created_byinteger
- formatstringOne of:
"csv"
"json"
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- refreshstringDefault:
force_cache
One of:"async"
"async_except_on_cache_miss"
"blocking"
"force_async"
"force_blocking"
"force_cache"
"lazy_async"
Whether to refresh the retrieved insights, how aggresively, and if sync or async:
'force_cache'
- return cached data or a cache miss; always completes immediately as it never calculates'blocking'
- calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache'async'
- kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache'lazy_async'
- kick off background calculation, UNLESS there are somewhat fresh results in the cache'force_blocking'
- calculate synchronously, even if fresh results are already cached'force_async'
- kick off background calculation, even if fresh results are already cached Background calculation can be tracked using thequery_status
response field.
- short_idstring
Response
Example request
GET
/api /environments /:project_id /insights
Example response
Status 200
List all environments insights
Required API key scopes
insight: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
- basicboolean
Return basic insight metadata only (no results, faster).
- created_byinteger
- formatstringOne of:
"csv"
"json"
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- refreshstringDefault:
force_cache
One of:"async"
"async_except_on_cache_miss"
"blocking"
"force_async"
"force_blocking"
"force_cache"
"lazy_async"
Whether to refresh the retrieved insights, how aggresively, and if sync or async:
'force_cache'
- return cached data or a cache miss; always completes immediately as it never calculates'blocking'
- calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache'async'
- kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache'lazy_async'
- kick off background calculation, UNLESS there are somewhat fresh results in the cache'force_blocking'
- calculate synchronously, even if fresh results are already cached'force_async'
- kick off background calculation, even if fresh results are already cached Background calculation can be tracked using thequery_status
response field.
- short_idstring
Response
Example request
GET
/api /environments /:project_id /insights
Example response
Status 200
Create environments insights
Required API key scopes
insight: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:
"csv"
"json"
Request parameters
- namestring
- derived_namestring
- queryobject
- orderinteger
- deletedboolean
- dashboardsarray
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
- descriptionstring
- tagsarray
- favoritedboolean
- _create_in_folderstring
Response
Example request
POST
/api /environments /:project_id /insights
Example response
Status 201
Create environments insights
Required API key scopes
insight: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:
"csv"
"json"
Request parameters
- namestring
- derived_namestring
- queryobject
- orderinteger
- deletedboolean
- dashboardsarray
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
- descriptionstring
- tagsarray
- favoritedboolean
- _create_in_folderstring
Response
Example request
POST
/api /environments /:project_id /insights
Example response
Status 201
List all environments insights sharing
Required API key scopes
sharing_configuration:read
Path parameters
- insight_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 /insights /:insight_id /sharing