Sign in
Users (admin)

Retrieve calendar heatmap activity

Changed on

Retrieve activity counts for a specified period, in a calendar heatmap format.

get/admin/users/{id}/calendar-heatmap

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/admin/users/{id}/calendar-heatmap
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Path parameters

idstring uuid required

Query parameters

fromstring date
Example:2024-01-01

Start date in UTC

tostring date
Example:2024-01-01

End date in UTC

type'Upload' | 'Taken'

Type of calendar heatmap

Response

fromstring required

Start date in UTC

tostring required

End date in UTC

totalCountinteger required

Total activity count over the period

Example response

{
  "from": "2024-01-01",
  "series": [
    {
      "date": "2024-01-01"
    }
  ],
  "to": "2024-12-31"
}

Changes