Subscriptions
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
GET | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST |
List all environments subscriptions
Required API key scopes
subscription:readQuery parameters
- created_bystring
- dashboardinteger
- insightinteger
- limitinteger
- offsetinteger
- orderingstring
- resource_typestringOne of:
"dashboard""insight" - searchstring
- target_typestringOne of:
"email""slack""webhook"
Response
Example request
GET /api /environments /:environment_id /subscriptionsExample response
Status 200
RESPONSE
Create environments subscriptions
Required API key scopes
subscription:writeRequest parameters
- dashboardinteger
- insightinteger
- dashboard_export_insightsarray
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- integration_idinteger
- invite_messagestring
- summary_enabledboolean
- summary_prompt_guidestring
Response
Example request
POST /api /environments /:environment_id /subscriptionsExample response
Status 201
RESPONSE
Retrieve environments subscriptions
Required API key scopes
subscription:readPath parameters
- idinteger
Response
Example request
GET /api /environments /:environment_id /subscriptions /:idExample response
Status 200
RESPONSE
Update environments subscriptions
Required API key scopes
subscription:writePath parameters
- idinteger
Request parameters
- dashboardinteger
- insightinteger
- dashboard_export_insightsarray
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- integration_idinteger
- invite_messagestring
- summary_enabledboolean
- summary_prompt_guidestring
Response
Example request
PATCH /api /environments /:environment_id /subscriptions /:idExample response
Status 200
RESPONSE
Delete environments subscriptions
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
subscription:writePath parameters
- idinteger
Example request
DELETE /api /environments /:environment_id /subscriptions /:idExample response
Status 405 No response body
Create environments subscriptions test delivery
Required API key scopes
subscription:writePath parameters
- idinteger
Example request
POST /api /environments /:environment_id /subscriptions /:id /test-deliveryExample response
Status 202 Test delivery workflow started
List all subscriptions deliveries
Paginated delivery history for a subscription. Requires premium subscriptions.
Required API key scopes
subscription:readPath parameters
- subscription_idinteger
Query parameters
- cursorstring
- statusstringOne of:
"completed""failed""skipped""starting"
Response
Example request
GET /api /environments /:project_id /subscriptions /:subscription_id /deliveriesExample response
Status 200
RESPONSE
Retrieve subscriptions deliveries
Fetch one delivery row by id.
Required API key scopes
subscription:readPath parameters
- idstring
- subscription_idinteger
Response
Example request
GET /api /environments /:project_id /subscriptions /:subscription_id /deliveries /:idExample response
Status 200
RESPONSE
List all subscriptions
Required API key scopes
subscription:readQuery parameters
- created_bystring
- dashboardinteger
- insightinteger
- limitinteger
- offsetinteger
- orderingstring
- resource_typestringOne of:
"dashboard""insight" - searchstring
- target_typestringOne of:
"email""slack""webhook"
Response
Example request
GET /api /projects /:project_id /subscriptionsExample response
Status 200
RESPONSE
Create subscriptions
Required API key scopes
subscription:writeRequest parameters
- dashboardinteger
- insightinteger
- dashboard_export_insightsarray
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- integration_idinteger
- invite_messagestring
- summary_enabledboolean
- summary_prompt_guidestring
Response
Example request
POST /api /projects /:project_id /subscriptionsExample response
Status 201
RESPONSE
Retrieve subscriptions
Required API key scopes
subscription:readPath parameters
- idinteger
Response
Example request
GET /api /projects /:project_id /subscriptions /:idExample response
Status 200
RESPONSE
Update subscriptions
Required API key scopes
subscription:writePath parameters
- idinteger
Request parameters
- dashboardinteger
- insightinteger
- dashboard_export_insightsarray
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- integration_idinteger
- invite_messagestring
- summary_enabledboolean
- summary_prompt_guidestring
Response
Example request
PATCH /api /projects /:project_id /subscriptions /:idExample response
Status 200
RESPONSE
Delete subscriptions
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
subscription:writePath parameters
- idinteger
Example request
DELETE /api /projects /:project_id /subscriptions /:idExample response
Status 405 No response body
Create subscriptions test delivery
Required API key scopes
subscription:writePath parameters
- idinteger
Example request
POST /api /projects /:project_id /subscriptions /:id /test-delivery