get_user_counts
Retrieve aggregated user count metrics to track account holders, suspended users, and growth trends for program monitoring and analytics. Supports day, week, and month aggregation periods.
Instructions
Get user count metrics aggregated over time. Track users with accounts, suspended users, and user growth. Essential for program monitoring and analytics. Supports day, week, and month aggregation. Note: DiVA API limits results to 10,000 records per query.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aggregation | No | Time period for aggregation (no detail level) | day |
| fields | No | Specific fields to return | |
| filters | No | Filters on data fields. For date filtering, use actual date field names with operators. | |
| sort_by | No | Field to sort by | |
| count | No | Maximum records to return (up to 10,000, default 10,000) | |
| program | No | Override default program |