Annotations

Get a website annotation

GET/api/websites/{websiteId}/annotations/{annotationId}

Returns the date, all-day setting, and note for a specific website annotation.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.
x-umami-share-contextrequired	string	Required context header when authenticating with a share token. `<api-key>`.
x-umami-share-tokenrequired	string	Signed token returned by a share endpoint. `<api-key>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.
annotationIdrequired	string	ID of the annotation.

Responses

200The operation completed successfully.

Name	Type	Description
allDayrequired	boolean	Whether the annotation applies to the entire day.
createdAtrequired	string	Date and time the record was created.
daterequired	string
idrequired	string	Unique identifier of the resource.
noterequired	string	Text of the annotation.
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.
websiteIdrequired	string	ID of the website.

200 example

{
  "allDay": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "date": "2024-01-15T09:30:00Z",
  "id": "string",
  "note": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string",
  "websiteId": "string"
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

404Not found.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/websites/{websiteId}/annotations/{annotationId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-umami-share-context: <api-key>' \
  -H 'x-umami-share-token: <api-key>'

PreviousCreate a website annotation NextUpdate a website annotation