post https://ge1.api.central.arubanetworks.com/network-reporting/v1alpha1/reports
This API allows users to generate reports based on various filters, report periods, and scheduling options. The reports can be scheduled for one-time or recurring execution and sent via email in multiple formats.
General Parameters
| Parameter | Description | Required |
|---|---|---|
| name | Name of the report. | true |
| type | Type of the report. Refer Report Type for more details. | true |
| timeZone | User time zone in IANA format egs., America/New_York | true |
| filters | Filters applied to refine report data. Refer Report Filter for more details. | true |
| reportPeriod | Time range defining the report's data scope. Refer Report Period for more details. | true |
| reportSchedule | Defines how often the report is generated. Refer Report Schedule for more details. | true |
| Email recipients and report format. | false |
Report Type
| Report Type | Report Name | Supported Filters |
|---|---|---|
| appAnalytics | Application Analytics | scope, sites, deviceTypes, connectionType, appCategories |
| clientInventory | Client Inventory | scope, sites, deviceTypes, connectionType |
| clientSession | Client Session | scope, sites, deviceTypes, connectionType |
| capacityPlanning | Capacity Planning | scope, sites, deviceTypes, switchPercentageOfTimeGreaterThanThreshold, switchMemoryUtilThreshold |
| deviceUptime | Device Uptime | scope, sites, deviceTypes |
| inventory | Inventory | scope, sites, deviceTypes |
| networkUsage | Network Usage | scope, sites, deviceTypes |
| resourceUtilization | Resource Utilization | scope, sites, deviceTypes, apMemoryUtilThreshold, switchMemoryUtilThreshold, gatewayMemoryUtilThreshold, apCpuUtilThreshold, gatewayCpuUtilThreshold, switchCpuUtilThreshold |
| rfHealth | RF Health | scope, sites, radioFrequency |
Report Filter
| Filter | Filter Name | Description | Required |
|---|---|---|---|
| scope | Scope | Scope filter for Report. Must be global or sites. | true if applicable |
| sites | Sites | Site IDs filter for report. List of Sites IDs obtained from Site Health API | true if scope is sites |
| deviceTypes | Device Types | Device type filter. Allowed values: access_points, switches, gateways. | true if applicable |
| connectionType | Connection Type | Connection Type filter. Allowed values: wired, wireless, all. | true if applicable |
| radioFrequency | Frequency Band | Frequency Band filter. Allowed values: 2.4GHz, 5GHz, 6GHz. | true if applicable |
| appCategories | Application Categories | Application Category filter. Allowed values: Any. | true if applicable |
| apCpuUtilThreshold | AP CPU Utilization Threshold | AP CPU utilization threshold filter. Range: 0-100 (default: 70). | false |
| switchCpuUtilThreshold | Switch CPU Utilization Threshold | Switch CPU utilization threshold filter. Range: 0-100 (default: 70). | false |
| gatewayCpuUtilThreshold | Gateway CPU Utilization Threshold | Gateway CPU utilization threshold filter. Range: 0-100 (default: 70). | false |
| apMemoryUtilThreshold | AP Memory Utilization Threshold | AP memory utilization threshold filter. Range: 0-100 (default: 70). | false |
| switchMemoryUtilThreshold | Switch Memory Utilization Threshold | Switch memory utilization threshold filter. Range: 0-100 (default: 70). | false |
| gatewayMemoryUtilThreshold | Gateway Memory Utilization Threshold | Gateway memory utilization Threshold filter. Range: 0-100 (default: 70). | false |
| switchCapacityThreshold | Switch Capacity Threshold | Switch capacity threshold filter. Range: 0-99 (default: 40). | false |
| switchPercentageOfTimeGreaterThanThreshold | Percentage of time switch meeting the threshold | Percentage of time switch meeting the threshold filter. Range: 0-99 (default: 25). | false |
Report Period
| Report Period | Allowed Fields | Allowed Schedules |
|---|---|---|
| LAST_DAY | sliceTime, sliceDays | ONE_TIME, EVERY_DAY |
| LAST_WEEK | sliceTime, sliceDays | ONE_TIME, EVERY_WEEK, EVERY_MONTH |
| LAST_MONTH | sliceTime, sliceDays | ONE_TIME, EVERY_MONTH |
| CUSTOM_RANGE | from, to timestamps (No sliceDays or sliceTime) | ONE_TIME |
sliceTime and sliceDays are applicable only for resourceUtilization and capacityPlanning report types.
Report Schedule
| Schedule Type | Required Fields | Applicable Report Periods |
|---|---|---|
| ONE_TIME | None | All report periods |
| EVERY_DAY | startDate, endDate | LAST_DAY |
| EVERY_WEEK | startDate, endDate | LAST_WEEK |
| EVERY_MONTH | startDate, endDate | LAST_WEEK, LAST_MONTH |