List Users
rybbit_list_usersList all users for a site with session counts, first and last seen dates, and user traits. Filter by any analytics dimension or search by username, email, or name using case-insensitive partial matching.
Instructions
List users for a site. Returns user IDs, session counts, first/last seen dates, and user traits. Supports filtering by any analytics dimension. Use 'search' param to find users by username/email/name (case-insensitive partial match).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | Yes | Site ID (numeric ID or domain identifier) | |
| startDate | No | Start date in ISO format (YYYY-MM-DD) | |
| endDate | No | End date in ISO format (YYYY-MM-DD) | |
| timeZone | No | IANA timezone (e.g., Europe/Prague). Default: UTC | |
| filters | No | Array of filters. Example: [{parameter:'browser',type:'equals',value:['Chrome']},{parameter:'country',type:'equals',value:['US','DE']}] | |
| pastMinutesStart | No | Alternative to dates: minutes ago start (e.g., 60 = last hour) | |
| pastMinutesEnd | No | Alternative to dates: minutes ago end (default 0 = now) | |
| page | No | Page number, 1-indexed (default: 1) | |
| limit | No | Results per page (default: 20-50 depending on endpoint, max 200) | |
| search | No | Search users by trait value (e.g. username, email). Uses case-insensitive partial matching (ILIKE). | |
| searchField | No | Which field to search in (default: 'username'). Only used when 'search' is provided. | |
| identifiedOnly | No | Only return identified users (users with identified_user_id). Default: false. | |
| sortBy | No | Sort field (default: 'last_seen'). 'duration' sorts by total time spent (aggregated from sessions, requires date range). | |
| sortOrder | No | Sort direction (default: 'desc') |