List sessions
list_sessionsRead-only
Retrieve paginated visitor sessions with browser, OS, device, and geo details. Filter by date range, search, or criteria like URL, referrer, or country.
Instructions
Paginated list of individual visitor sessions over a date range (id, browser, os, device, geo, screen, visits, views, firstAt/lastAt). Supports search + filters.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| os | No | ||
| tag | No | ||
| url | No | ||
| city | No | ||
| host | No | ||
| page | No | 1-based page number. | |
| endAt | No | Explicit end — ISO 8601, YYYY-MM-DD, or epoch milliseconds. Defaults to now. | |
| event | No | ||
| query | No | ||
| range | No | Relative window: "24h", "7d", "30d", "12w", "today", "yesterday", "this-week", "last-month", "this-year". Ignored when startAt/endAt are set. Default "7d". | |
| title | No | ||
| device | No | ||
| region | No | ||
| search | No | Substring filter. | |
| browser | No | ||
| country | No | ||
| startAt | No | Explicit start — ISO 8601, YYYY-MM-DD, or epoch milliseconds. Overrides range. | |
| language | No | ||
| pageSize | No | Results per page (max 200). | |
| referrer | No | ||
| websiteId | Yes | Umami website UUID (obtain from list_websites). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| count | Yes | ||
| websiteId | Yes |