Subscriptions
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE |
List all subscriptions
Required API key scopes
subscription: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
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET
/api /projects /:project_id /subscriptions
Example response
Status 200
Create subscriptions
Required API key scopes
subscription: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/.
Request parameters
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
Example request
POST
/api /projects /:project_id /subscriptions
Example response
Status 201
Retrieve subscriptions
Required API key scopes
subscription:read
Path parameters
- idinteger
A unique integer value identifying this subscription.
- 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 /projects /:project_id /subscriptions /:id
Example response
Status 200
Update subscriptions
Required API key scopes
subscription:write
Path parameters
- idinteger
A unique integer value identifying this subscription.
- 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
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
Example request
PATCH
/api /projects /:project_id /subscriptions /:id
Example response
Status 200
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:write
Path parameters
- idinteger
A unique integer value identifying this subscription.
- 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
DELETE
/api /projects /:project_id /subscriptions /:id