Sign in
Timeline

Get time buckets

Changed on

Retrieve a list of all minimal time buckets.

get/timeline/buckets

Request

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

Query parameters

albumIdstring uuid

Filter assets belonging to a specific album

bboxstring
Example:11.075683,49.416711,11.117589,49.454875

Bounding box coordinates as west,south,east,north (WGS84)

isFavoriteboolean

Filter by favorite status (true for favorites only, false for non-favorites only)

isTrashedboolean

Filter by trash status (true for trashed assets only, false for non-trashed only)

keystring
order'asc' | 'desc'

Asset sort order

Sort order for assets within time buckets (ASC for oldest first, DESC for newest first)

orderBy'takenAt' | 'createdAt'

Asset sorting property

Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich)

personIdstring uuid

Filter assets containing a specific person (face recognition)

slugstring
tagIdstring uuid

Filter assets with a specific tag

userIdstring uuid

Filter assets by specific user ID

visibility'archive' | 'timeline' | 'hidden' | 'locked'

Asset visibility

Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)

withCoordinatesboolean

Include location data in the response

withPartnersboolean

Include assets shared by partners

withStackedboolean

Include stacked assets in the response. When true, only primary assets from stacks are returned.

Response

countinteger required

Number of assets in this time bucket

timeBucketstring required

Time bucket identifier in YYYY-MM-DD format representing the start of the time period

Example response

[
  {
    "count": 42,
    "timeBucket": "2024-01-01"
  }
]

Changes