annotations

Embed
Preview of the card
<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-annotations"><img src="https://lucida.15-204-158-166.sslip.io/docs/_api/public/orgs/af34862a-c837-4478-8335-0505efe40459/spaces/da916cd3-c0fc-4b63-b971-b3c13623daf3/pages/46d74eb4-5e89-465c-be81-7002f409afa2/social-card.svg?v=3e7ae33eec8b" alt="annotations" width="600" height="315"></a>
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/annotations

Parameters

project_idstringpathrequired
fromstringquery
tostringquery
limitintegerquery
cursorstringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/annotations"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Page of Annotation, newest first
404
POSThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/annotations

Parameters

project_idstringpathrequired

Request body

application/json
atstringrequired
contentstringrequired
emojistring
One emoji (at most 8 characters, no letters or digits) shown as the marker.
scopestring
project (default), organization, insight or dashboard.
scope_idstring
Required for insight and dashboard scopes.
{
  "at": "2024-01-01T00:00:00Z",
  "content": "string",
  "emoji": "string",
  "scope": "string",
  "scope_id": "string"
}

Code samples

cURL
curl -X POST "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/annotations" \
  -H "Content-Type: application/json" \
  -d '{"at":"2024-01-01T00:00:00Z","content":"string","emoji":"string","scope":"string","scope_id":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201
Example
{
  "at": "2024-01-01T00:00:00Z",
  "content": "string",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": "string",
  "emoji": "string",
  "id": "string",
  "scope": "string",
  "scope_id": "string",
  "source": "string"
}
Schema
atstringrequired
contentstringrequired
created_atstringrequired
created_bystring
emojistringrequired
Up to 8 characters, "" for none.
idstringrequired
scopestringrequired
project | organization | insight | dashboard
scope_idstring
sourcestringrequired
400
403
404
DELETEhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/annotations/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X DELETE "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/annotations/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
403
404
PATCHhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/annotations/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Request body

application/json
atstring
contentstring
emojistring
"" clears it.
{
  "at": "2024-01-01T00:00:00Z",
  "content": "string",
  "emoji": "string"
}

Code samples

cURL
curl -X PATCH "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/annotations/{id}" \
  -H "Content-Type: application/json" \
  -d '{"at":"2024-01-01T00:00:00Z","content":"string","emoji":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200

Same as 201 · POST /v1/projects/{project_id}/annotations

400
403
404
Updated