Dashboards
For instructions on how to authenticate to use this endpoint, see API overview.
Override the default in ModelViewSet that allows callers to destroy a model instance.
Endpoints
List all dashboards
Path Parameters
- project_idstring
Query Parameters
- limitinteger
- offsetinteger
Response
Request
GET /api/projects/:project_id/dashboards/Response
{"count": 123,"next": "http://api.example.org/accounts/?offset=400&limit=100","previous": "http://api.example.org/accounts/?offset=200&limit=100","results": [{"id": 0,"name": "string","description": "string","pinned": true,"items": "string","created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"is_shared": true,"deleted": true,"creation_mode": "default","use_template": "string","use_dashboard": 0,"filters": {"property1": null,"property2": null},"tags": [null],"restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}]}
Create dashboards
Path Parameters
- project_idstring
Request Parameters
- namestring
- descriptionstring
- pinnedboolean
- deletedboolean
- use_templatestring
- use_dashboardinteger
- filtersobject
- tagsarray
- restriction_levelintegerOne of:
"21""37"
Response
Request
POST /api/projects/:project_id/dashboards/Response
{"id": 0,"name": "string","description": "string","pinned": true,"items": "string","created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"is_shared": true,"deleted": true,"creation_mode": "default","use_template": "string","use_dashboard": 0,"filters": {"property1": null,"property2": null},"tags": [null],"restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}
Retrieve dashboards
Path Parameters
- idinteger
- project_idstring
Response
Request
GET /api/projects/:project_id/dashboards/:id/Response
{"id": 0,"name": "string","description": "string","pinned": true,"items": "string","created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"is_shared": true,"deleted": true,"creation_mode": "default","use_template": "string","use_dashboard": 0,"filters": {"property1": null,"property2": null},"tags": [null],"restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}
Update dashboards
Path Parameters
- idinteger
- project_idstring
Request Parameters
- namestring
- descriptionstring
- pinnedboolean
- deletedboolean
- use_templatestring
- use_dashboardinteger
- filtersobject
- tagsarray
- restriction_levelintegerOne of:
"21""37"
Response
Request
PATCH /api/projects/:project_id/dashboards/:id/Response
{"id": 0,"name": "string","description": "string","pinned": true,"items": "string","created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"is_shared": true,"deleted": true,"creation_mode": "default","use_template": "string","use_dashboard": 0,"filters": {"property1": null,"property2": null},"tags": [null],"restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}
Delete dashboards
Path Parameters
- idinteger
- project_idstring
Request
DELETE /api/projects/:project_id/dashboards/:id/