Annotations
For instructions on how to authenticate to use this endpoint, see API overview.
Create, Read, Update and Delete annotations. See docs for more information on annotations.
Endpoints
List all annotations
Path Parameters
- project_idstring
Query Parameters
- limitinteger
- offsetinteger
- searchstring
Response
Request
GET /api/projects/:project_id/annotations/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,"content": "string","date_marker": "2019-08-24T14:15:22Z","creation_type": "USR","dashboard_item": 0,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","deleted": true,"scope": "dashboard_item"}]}
Create annotations
Path Parameters
- project_idstring
Request Parameters
- contentstring
- date_markerstring
- dashboard_iteminteger
- deletedboolean
- scopestringOne of:
"dashboard_item""project""organization"
Response
Request
POST /api/projects/:project_id/annotations/Response
{"id": 0,"content": "string","date_marker": "2019-08-24T14:15:22Z","creation_type": "USR","dashboard_item": 0,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","deleted": true,"scope": "dashboard_item"}
Retrieve annotations
Path Parameters
- idinteger
- project_idstring
Response
Request
GET /api/projects/:project_id/annotations/:id/Response
{"id": 0,"content": "string","date_marker": "2019-08-24T14:15:22Z","creation_type": "USR","dashboard_item": 0,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","deleted": true,"scope": "dashboard_item"}
Update annotations
Path Parameters
- idinteger
- project_idstring
Request Parameters
- contentstring
- date_markerstring
- dashboard_iteminteger
- deletedboolean
- scopestringOne of:
"dashboard_item""project""organization"
Response
Request
PATCH /api/projects/:project_id/annotations/:id/Response
{"id": 0,"content": "string","date_marker": "2019-08-24T14:15:22Z","creation_type": "USR","dashboard_item": 0,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com"},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","deleted": true,"scope": "dashboard_item"}
Delete annotations
Path Parameters
- idinteger
- project_idstring
Request
DELETE /api/projects/:project_id/annotations/:id/