Annotations

List website annotations

GET/api/websites/{websiteId}/annotations

Returns a paginated list of dated notes for the website, optionally filtered by date range or search text.

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.

Query parameters

Name	Type	Description
startAt	integer	Start of the date range as a Unix timestamp in milliseconds.
endAt	integer	End of the date range as a Unix timestamp in milliseconds.
search	string	Search text used to filter results.
page	integer	Page number, starting at 1.
pageSize	integer	Number of results per page.
maxResults	integer	Maximum number of results to include.
period	enum<string>	Relative date range, for example 7d or 30day, used instead of an explicit startAt/endAt range. Options: `today`, `24h`, `7d`, `30d`, `0day`, `24hour`, `0week`, `7day`, `0month`, `30day`, `90day`, `0year`, `6month`, `12month`

Responses

200The operation completed successfully.

Name	Type	Description
countrequired	number	Number of matching records.
datarequired	object[]	Data returned by the operation.

isCapped	boolean	Whether the results were truncated by the maximum result limit.
orderBy	string	Field to sort the results by.
pagerequired	number	Page number, starting at 1.
pageSizerequired	number	Number of results per page.
search	string	Search text used to filter results.
sortDescending	boolean	Whether to sort results in descending order.

200 example

{
  "count": 0,
  "data": [
    {
      "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"
    }
  ],
  "isCapped": true,
  "orderBy": "string",
  "page": 0,
  "pageSize": 0,
  "search": "string",
  "sortDescending": true
}

400Bad request.

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

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

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

401 example

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

Code samples

cURL

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

PreviousSet the two-factor requirement for everyone NextCreate a website annotation