HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

Create Report

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

ParameterDescriptionRequired
nameName of the report.true
typeType of the report.
Refer Report Type for more details.
true
timeZoneUser time zone in IANA format egs., America/New_Yorktrue
filtersFilters applied to refine report data.
Refer Report Filter for more details.
true
reportPeriodTime range defining the report's data scope.
Refer Report Period for more details.
true
reportScheduleDefines how often the report is generated.
Refer Report Schedule for more details.
true
emailEmail recipients and report format.false

Report Type

Report TypeReport NameSupported Filters
appAnalyticsApplication Analyticsscope, sites, deviceTypes, connectionType, appCategories
clientInventoryClient Inventoryscope, sites, deviceTypes, connectionType, includeDevices
clientSessionClient Sessionscope, sites, deviceTypes, connectionType, includeDevices, excludeDevices
capacityPlanningCapacity Planningscope, sites, deviceTypes, switchPercentageOfTimeGreaterThanThreshold, switchMemoryUtilThreshold, includeDevices, excludeDevices
deviceUptimeDevice Uptimescope, sites, deviceTypes, includeDevices, excludeDevices
inventoryInventoryscope, sites, deviceTypes, includeDevices
networkUsageNetwork Usagescope, sites, deviceTypes, includeDevices, excludeDevices
resourceUtilizationResource Utilizationscope, sites, deviceTypes, apMemoryUtilThreshold, switchMemoryUtilThreshold, gatewayMemoryUtilThreshold, apCpuUtilThreshold, gatewayCpuUtilThreshold, switchCpuUtilThreshold, includeDevices, excludeDevices
rfHealthRF Healthscope, sites, radioFrequency, includeDevices, excludeDevices
customCustomFilter support varies with respect to KPI selection. Refer Reports Metadata API

For Custom reports, If selected KPI has no columns selected then all mandatory and pre-selected optional columns will be included in created report.

Report Filter

FilterFilter NameDescriptionRequired
scopeScopeScope filter for Report.
Must be global or sites.
true if applicable
sitesSitesSite IDs filter for report.
List of Sites IDs obtained from Site Health API
true if scope is sites
deviceTypesDevice TypesDevice type filter.
Allowed values: access_points, switches, gateways.
true if applicable
connectionTypeConnection TypeConnection Type filter.
Allowed values: wired, wireless, all.
true if applicable
radioFrequencyFrequency BandFrequency Band filter.
Allowed values: 2.4GHz, 5GHz, 6GHz.
true if applicable
appCategoriesApplication CategoriesApplication Category filter.
Allowed values: Any.
true if applicable
apCpuUtilThresholdAP CPU Utilization ThresholdAP CPU utilization threshold filter.
Range: 0-100 (default: 70).
false
switchCpuUtilThresholdSwitch CPU Utilization ThresholdSwitch CPU utilization threshold filter.
Range: 0-100 (default: 70).
false
gatewayCpuUtilThresholdGateway CPU Utilization ThresholdGateway CPU utilization threshold filter.
Range: 0-100 (default: 70).
false
apMemoryUtilThresholdAP Memory Utilization ThresholdAP memory utilization threshold filter.
Range: 0-100 (default: 70).
false
switchMemoryUtilThresholdSwitch Memory Utilization ThresholdSwitch memory utilization threshold filter.
Range: 0-100 (default: 70).
false
gatewayMemoryUtilThresholdGateway Memory Utilization ThresholdGateway memory utilization Threshold filter.
Range: 0-100 (default: 70).
false
switchCapacityThresholdSwitch Capacity ThresholdSwitch capacity threshold filter.
Range: 0-99 (default: 40).
false
switchPercentageOfTimeGreaterThanThresholdPercentage of time switch meeting the thresholdPercentage of time switch meeting the threshold filter.
Range: 0-99 (default: 25).
false
includeDevicesInclude DevicesList of Device Serial Number obtained from Device Monitoring API to be included in report.false
excludeDevicesExclude DevicesList of Device Serial Number obtained from Device Monitoring API to be excluded from report.false

Report Period

Report PeriodAllowed FieldsAllowed Schedules
LAST_DAYsliceTimeONE_TIME, EVERY_DAY
LAST_WEEKsliceTime, sliceDaysONE_TIME, EVERY_WEEK, EVERY_MONTH
LAST_MONTHsliceTime, sliceDaysONE_TIME, EVERY_MONTH
CUSTOM_RANGEfrom, to timestamps (No sliceDays or sliceTime)ONE_TIME

sliceTime and sliceDays are applicable only for resourceUtilization and capacityPlanning report types.

Report Schedule

Schedule TypeRequired FieldsApplicable Report Periods
ONE_TIMENoneAll report periods
EVERY_DAYstartDate, endDateLAST_DAY
EVERY_WEEKstartDate, endDateLAST_WEEK
EVERY_MONTHstartDate, endDateLAST_WEEK, LAST_MONTH
Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!