Request Usage-By-User Report
lyzr_report_usage_by_userRequest an asynchronous usage report broken down by user. Choose a timeframe and optional grouping, then poll the returned job ID for results.
Instructions
Request an async usage report broken down by user. Returns a job_id; poll with lyzr_report_get_status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | End date (YYYY-MM-DD), required when timeframe is 'custom' | |
| group_by | No | Optional row-splitting dimension: 'month' splits by calendar month, 'billing_cycle' splits by the org's subscription cycle. Omit for a single aggregated row per entity. | |
| timeframe | Yes | Timeframe preset for the report window. Use 'custom' with start_date/end_date. | |
| start_date | No | Start date (YYYY-MM-DD), required when timeframe is 'custom' | |
| include_sub_orgs | No | When true, include usage from the current org AND all its sub-orgs |