Actions41
- Alert Actions
- Alert History Actions
- ASM Actions
- Component Actions
- Configuration Actions
- Device Actions
- Device V2 (Beta) Actions
- Entity Actions
- Interface Actions
- Network Actions
- Playbook Actions
- SNMP Poller Actions
- Tenant Actions
- Usage Actions
Usage → Get Client Usage
AI-generatedSummary
Retrieves Auvik usage data aggregated per client (tenant) for a chosen time window, optionally limited to selected tenants.
Inputs
- Date Preset — Quick date range selector (e.g. Last 24 hours, Last 7 days, Last month, Year to date, Yesterday). Defaults to No Filter; choose Custom to supply explicit dates.
- From Date (required) — Start date in YYYY-MM-DD format. Shown and required only when Date Preset is Custom.
- Thru Date (required) — End date in YYYY-MM-DD format. Shown and required only when Date Preset is Custom.
- Tenants — Multi-select of tenants to query, loaded dynamically from your Auvik account. Leave empty for the default tenant scope.
Output shape
Client usage records returned by the Auvik usage API, for the selected tenants and date range.
The source pack shows only signatures for the usage execute module, so the exact return structure, pagination and how presets map to query parameters are not visible. Requests use shared retry/backoff handling for rate limits and 5xx errors. Auvik API credentials are required.
Examples
Example 1: Report client usage for the past week across all tenants
Date Preset = Last 7 days; Tenants left empty.
Example 2: Pull usage for a specific billing period for two tenants
Date Preset = Custom; From Date = 2025-01-01; Thru Date = 2025-01-31; Tenants = two selected tenants.