Get time report
get_reportAggregate time report for any period: total active seconds, top apps, and top projects with nested sub-projects. Filter by hours, weekdays, or device.
Instructions
Aggregate Vetroscope time report for a period: total active seconds, top apps, and top projects (with sub-projects nested when present — e.g. individual YouTube videos, SoundCloud songs, Netflix episodes). Apps include the user's custom display_name when set. Applies the same SQLite settings as the desktop dashboard — ignored apps, ignored projects/breakdown patterns, and days_filter — plus optional hour-of-day/weekday/device filters layered on top. Totals therefore match Charts/Dashboard totals for the same range.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | today | yesterday | week | month | year | a single date YYYY-MM-DD | an inclusive date range YYYY-MM-DD..YYYY-MM-DD | today |
| top_apps | No | Max apps returned (default 50, 0 to omit) | |
| top_projects | No | Max projects returned (default 50, 0 to omit) | |
| top_sub_projects | No | Max sub-projects per project (default 25, 0 to omit) | |
| hour_start | No | Inclusive start hour 0-24 in local time. Combine with hour_end (e.g. 9 and 17 = 9am to 4:59pm). Omit both for no hour filter. | |
| hour_end | No | Exclusive end hour 0-24 in local time. Combine with hour_start. | |
| weekdays | No | Restrict to specific weekdays. 0=Sunday, 1=Monday, …, 6=Saturday. Omit or pass [0,1,2,3,4,5,6] for no weekday filter. | |
| device | No | Restrict to a single device. Pass 'current' (or 'this') for the local machine, a device UUID from get_device_breakdown, or a platform name like 'darwin', 'win32', 'browser-extension'. Omit or pass 'all' for no device filter. |