# Get APs Aggregation Details (deprecated) Get parameters and operational data for a list of APs with aggregation details. This method will be removed no sooner than 08/31/2026. The following URL /venues/aps/query can be used for this content. Endpoint: POST /aps/aggregationDetails Version: 1.0.45 ## Request fields (application/json): - `excludeFilters` (object) Exclusion filters as key value pairs defining values to omit from results. - `exists` (string) Field name that must exist within each document matched by the query execution. - `fields` (array) Set of field names to include in response payload for each record. - `filters` (object) Filters provided as key value pairs defining inclusion criteria for query execution. - `groupBy` (string) Field name used to group aggregated results when producing grouped query responses. - `matchFields` (array) List of match field filters specifying terms that must align with query criteria. - `matchFields.field` (string) - `matchFields.value` (string) - `multiSortFields` (array) List of multiple field names applied for compound sorting logic in results. - `mustHaveFields` (array) List of fields that must exist on documents returned by the query. - `mustNotHaveFields` (array) List of fields that must not exist on documents included in results. - `mustNotMatchField` (array) - `mustNotMatchField.field` (string) - `mustNotMatchField.value` (string) - `page` (integer) Page number indicating current position within paginated query results. - `pageByDate` (object) Pagination by date entry specifying anchor timestamp for search after pagination. - `pageByDate.key` (string) - `pageByDate.value` (string) - `pageSize` (integer) Number of items per page controlling volume of results returned per page. - `queryStringOrFilter` (object) Query string or MAC filter configuration combining text search and device matching. - `queryStringOrFilter.filterTerms` (object) - `queryStringOrFilter.searchString` (string) - `rangeDateFilter` (object) Range date filter configuration defining temporal boundaries for returned records. - `rangeDateFilter.field` (string) - `rangeDateFilter.gte` (integer) - `rangeDateFilter.lt` (integer) - `rangeDateFilter.lte` (integer) - `rangeFilter` (object) Range filter configuration defining numeric or date boundaries for query results. - `searchString` (string) Search string representing the user query applied across designated target fields. - `searchTargetFields` (array) List of target field names that should be queried for search string matching. - `search_after` (array) Search after values used to continue pagination without relying on offsets. - `sortDescriptors` (array) List of sort descriptors defining multi level sort behaviors for query responses. - `sortField` (string) Field name used to sort query results within the returned data. - `sortOrder` (string) Sort order specifying ascending or descending direction for query results. - `termField` (object) Term field filter configuration specifying exact match criteria for a field. - `termField.field` (string) - `termField.value` (string) - `terms` (object) Filter terms represented as key value pairs applied to refine result sets. ## Response 200 fields (application/json): - `data` (array) List of data items returned by the query. - `data.aps` (array) - `data.aps.IP` (string) - `data.aps.apGroupId` (string) - `data.aps.apGroupName` (string) - `data.aps.apMac` (string) - `data.aps.apNeighborMacs` (array) - `data.aps.apNeighborRssis` (array) - `data.aps.apRadioDeploy` (string) - `data.aps.apStatusData` (object) Represents detailed operational status information for an access point device. - `data.aps.apStatusData.APRadio` (array) Radio operational status including transmit power, channel, frequency band, and signal strength for each radio interface. - `data.aps.apStatusData.APRadio.Rssi` (integer) A relative indication of the received power level of a client device's wireless transmissions as measured at the AP. RSSI is scored on a scale of 0 to 100 with 100 indicating a very high (good) received power level and 0 indicating an extremely low (poor) power level. - `data.aps.apStatusData.APRadio.actualTxPower` (integer) - `data.aps.apStatusData.APRadio.band` (string) - `data.aps.apStatusData.APRadio.calibrationTxPower` (integer) - `data.aps.apStatusData.APRadio.channel` (integer) - `data.aps.apStatusData.APRadio.operativeChannelBandwidth` (string) - `data.aps.apStatusData.APRadio.radioId` (integer) - `data.aps.apStatusData.APRadio.txPower` (string) The AP's transmitter power setting in dBm. - `data.aps.apStatusData.APRadio.wlans` (array) Operational Wi-Fi network information including BSSID and display name for this radio interface. - `data.aps.apStatusData.APSystem` (object) System level information including IP configuration, uptime, DNS settings, and network parameters. - `data.aps.apStatusData.APSystem.gateway` (string) - `data.aps.apStatusData.APSystem.ipType` (string) - `data.aps.apStatusData.APSystem.ipv6` (string) - `data.aps.apStatusData.APSystem.ipv6DnsSvr1` (string) - `data.aps.apStatusData.APSystem.ipv6DnsSvr2` (string) - `data.aps.apStatusData.APSystem.ipv6PrimaryDnsServer` (string) - `data.aps.apStatusData.APSystem.ipv6SecondaryDnsServer` (string) - `data.aps.apStatusData.APSystem.ipv6Type` (string) - `data.aps.apStatusData.APSystem.netmask` (string) - `data.aps.apStatusData.APSystem.primaryDnsServer` (string) - `data.aps.apStatusData.APSystem.secondaryDnsServer` (string) - `data.aps.apStatusData.APSystem.uptime` (integer) The elapsed time in seconds between the time of the AP's last reboot and now. - `data.aps.apStatusData.afcInfo` (object) Automated frequency coordination information for radio operations including AFC state and available channels. - `data.aps.apStatusData.afcInfo.afcStatus` (string) - `data.aps.apStatusData.afcInfo.availableChannel` (integer) - `data.aps.apStatusData.afcInfo.availableChannels` (array) - `data.aps.apStatusData.afcInfo.geoLocation` (object) - `data.aps.apStatusData.afcInfo.geoLocation.height` (number) - `data.aps.apStatusData.afcInfo.geoLocation.lateralUncertainty` (number) - `data.aps.apStatusData.afcInfo.geoLocation.latitude` (number) - `data.aps.apStatusData.afcInfo.geoLocation.longitude` (number) - `data.aps.apStatusData.afcInfo.geoLocation.source` (string) - `data.aps.apStatusData.afcInfo.geoLocation.verticalUncertainty` (number) - `data.aps.apStatusData.afcInfo.maxPowerDbm` (integer) - `data.aps.apStatusData.afcInfo.minPowerDbm` (integer) - `data.aps.apStatusData.afcInfo.powerMode` (string) - `data.aps.apStatusData.cellularInfo` (object) Cellular connection status and metrics for LTE enabled access points including signal strength, operator, and SIM details. - `data.aps.apStatusData.cellularInfo.cellular3G4GChannel` (integer) - `data.aps.apStatusData.cellularInfo.cellularActiveSim` (string) - `data.aps.apStatusData.cellularInfo.cellularBand` (string) - `data.aps.apStatusData.cellularInfo.cellularCardRemovalCountSIM0` (string) - `data.aps.apStatusData.cellularInfo.cellularCardRemovalCountSIM1` (string) - `data.aps.apStatusData.cellularInfo.cellularConnectionStatus` (string) - `data.aps.apStatusData.cellularInfo.cellularCountry` (string) - `data.aps.apStatusData.cellularInfo.cellularDHCPTimeoutCountSIM0` (string) - `data.aps.apStatusData.cellularInfo.cellularDHCPTimeoutCountSIM1` (string) - `data.aps.apStatusData.cellularInfo.cellularDefaultGateway` (string) - `data.aps.apStatusData.cellularInfo.cellularDownlinkBandwidth` (string) - `data.aps.apStatusData.cellularInfo.cellularECIO` (integer) - `data.aps.apStatusData.cellularInfo.cellularICCIDSIM0` (string) - `data.aps.apStatusData.cellularInfo.cellularICCIDSIM1` (string) - `data.aps.apStatusData.cellularInfo.cellularIMEI` (string) - `data.aps.apStatusData.cellularInfo.cellularIMSISIM0` (string) - `data.aps.apStatusData.cellularInfo.cellularIMSISIM1` (string) - `data.aps.apStatusData.cellularInfo.cellularIPaddress` (string) - `data.aps.apStatusData.cellularInfo.cellularIsSIM0Present` (string) - `data.aps.apStatusData.cellularInfo.cellularIsSIM1Present` (string) - `data.aps.apStatusData.cellularInfo.cellularLTEFirmware` (string) - `data.aps.apStatusData.cellularInfo.cellularNWLostCountSIM0` (string) - `data.aps.apStatusData.cellularInfo.cellularNWLostCountSIM1` (string) - `data.aps.apStatusData.cellularInfo.cellularOperator` (string) - `data.aps.apStatusData.cellularInfo.cellularRSCP` (integer) - `data.aps.apStatusData.cellularInfo.cellularRSRP` (integer) - `data.aps.apStatusData.cellularInfo.cellularRSRQ` (integer) - `data.aps.apStatusData.cellularInfo.cellularRadioUptime` (integer) - `data.aps.apStatusData.cellularInfo.cellularRoamingStatus` (string) - `data.aps.apStatusData.cellularInfo.cellularRxBytesSIM0` (string) - `data.aps.apStatusData.cellularInfo.cellularRxBytesSIM1` (string) - `data.aps.apStatusData.cellularInfo.cellularSINR` (integer) - `data.aps.apStatusData.cellularInfo.cellularSignalStrength` (string) - `data.aps.apStatusData.cellularInfo.cellularSubnetMask` (string) - `data.aps.apStatusData.cellularInfo.cellularSwitchCountSIM0` (string) - `data.aps.apStatusData.cellularInfo.cellularSwitchCountSIM1` (string) - `data.aps.apStatusData.cellularInfo.cellularTxBytesSIM0` (string) - `data.aps.apStatusData.cellularInfo.cellularTxBytesSIM1` (string) - `data.aps.apStatusData.cellularInfo.cellularUplinkBandwidth` (string) - `data.aps.apStatusData.cellularInfo.cellularWanInterface` (string) - `data.aps.apStatusData.lanPortStatus` (array) Physical status of LAN ports on the access point including link state and port identifiers. - `data.aps.apStatusData.lanPortStatus.phyLink` (string) - `data.aps.apStatusData.lanPortStatus.port` (string) - `data.aps.apStatusData.lanPortStatus.wanConnectivity` (string) - `data.aps.clients` (integer) - `data.aps.configStatus` (string) - `data.aps.connectionStatus` (string) - `data.aps.crtTime` (string) The UTC time in milliseconds at which the device was provisioned (created) into the cloud. - `data.aps.description` (string) - `data.aps.deviceGroupId` (string) - `data.aps.deviceGroupName` (string) - `data.aps.deviceModelType` (string) - `data.aps.deviceSessionCacheWeight` (integer) - `data.aps.deviceStatus` (string) - `data.aps.deviceStatusSeverity` (string) - `data.aps.downLinkCount` (integer) - `data.aps.downlink` (array) - `data.aps.downlink.IP` (string) - `data.aps.downlink.apGroupId` (string) - `data.aps.downlink.apGroupName` (string) - `data.aps.downlink.apMac` (string) - `data.aps.downlink.apNeighborMacs` (array) - `data.aps.downlink.apNeighborRssis` (array) - `data.aps.downlink.apRadioDeploy` (string) - `data.aps.downlink.apStatusData` (object) Represents detailed operational status information for an access point device. - `data.aps.downlink.clients` (integer) - `data.aps.downlink.configStatus` (string) - `data.aps.downlink.connectionStatus` (string) - `data.aps.downlink.crtTime` (string) The UTC time in milliseconds at which the device was provisioned (created) into the cloud. - `data.aps.downlink.description` (string) - `data.aps.downlink.deviceGroupId` (string) - `data.aps.downlink.deviceGroupName` (string) - `data.aps.downlink.deviceModelType` (string) - `data.aps.downlink.deviceSessionCacheWeight` (integer) - `data.aps.downlink.deviceStatus` (string) - `data.aps.downlink.deviceStatusSeverity` (string) - `data.aps.downlink.downLinkCount` (integer) - `data.aps.downlink.downMac` (string) - `data.aps.downlink.downlink.downMac` (array) - `data.aps.downlink.downlink.rssi` (array) - `data.aps.downlink.downlink.type` (array) - `data.aps.downlink.downlinkChannel` (string) - `data.aps.downlink.downlinkCount` (integer) - `data.aps.downlink.extIp` (string) - `data.aps.downlink.externalPort` (string) - `data.aps.downlink.floorplanId` (string) - `data.aps.downlink.fwVersion` (string) - `data.aps.downlink.geolocationSource` (string) - `data.aps.downlink.healthStatus` (string) - `data.aps.downlink.hops` (integer) - `data.aps.downlink.isMeshEnable` (boolean) - `data.aps.downlink.isStaging` (boolean) - `data.aps.downlink.lastSeenTime` (string) - `data.aps.downlink.lastUpdTime` (string) - `data.aps.downlink.latitude` (string) - `data.aps.downlink.longitude` (string) - `data.aps.downlink.meshRole` (string) - `data.aps.downlink.model` (string) - `data.aps.downlink.name` (string) - `data.aps.downlink.neighbors` (array) - `data.aps.downlink.neighbors.apName` (string) - `data.aps.downlink.neighbors.mac` (string) - `data.aps.downlink.neighbors.rssi` (integer) - `data.aps.downlink.poePort` (string) - `data.aps.downlink.poePortStatus` (string) - `data.aps.downlink.reboot` (boolean) - `data.aps.downlink.replacedByAp` (string) - `data.aps.downlink.rogueCategory` (object) The total amount of rogue devices for each category. - `data.aps.downlink.rssi` (integer) - `data.aps.downlink.rxBytes` (string) - `data.aps.downlink.rxFrames` (string) - `data.aps.downlink.serialNumber` (string) - `data.aps.downlink.switchId` (string) - `data.aps.downlink.switchName` (string) - `data.aps.downlink.switchPort` (string) - `data.aps.downlink.switchSerialNumber` (string) - `data.aps.downlink.tags` (string) - `data.aps.downlink.tenantId` (string) - `data.aps.downlink.txBytes` (string) - `data.aps.downlink.txFrames` (string) - `data.aps.downlink.type` (integer) - `data.aps.downlink.uplink` (array) - `data.aps.downlink.uplink.IP` (string) - `data.aps.downlink.uplink.apGroupId` (string) - `data.aps.downlink.uplink.apGroupName` (string) - `data.aps.downlink.uplink.apMac` (string) - `data.aps.downlink.uplink.apNeighborMacs` (array) - `data.aps.downlink.uplink.apNeighborRssis` (array) - `data.aps.downlink.uplink.apRadioDeploy` (string) - `data.aps.downlink.uplink.apStatusData` (object) Represents detailed operational status information for an access point device. - `data.aps.downlink.uplink.clients` (integer) - `data.aps.downlink.uplink.configStatus` (string) - `data.aps.downlink.uplink.connectionStatus` (string) - `data.aps.downlink.uplink.crtTime` (string) The UTC time in milliseconds at which the device was provisioned (created) into the cloud. - `data.aps.downlink.uplink.description` (string) - `data.aps.downlink.uplink.deviceDto` (object) - `data.aps.downlink.uplink.deviceGroupId` (string) - `data.aps.downlink.uplink.deviceGroupName` (string) - `data.aps.downlink.uplink.deviceModelType` (string) - `data.aps.downlink.uplink.deviceSessionCacheWeight` (integer) - `data.aps.downlink.uplink.deviceStatus` (string) - `data.aps.downlink.uplink.deviceStatusSeverity` (string) - `data.aps.downlink.uplink.downLinkCount` (integer) - `data.aps.downlink.uplink.downlink.downMac` (array) - `data.aps.downlink.uplink.downlink.rssi` (array) - `data.aps.downlink.uplink.downlink.type` (array) - `data.aps.downlink.uplink.downlinkChannel` (string) - `data.aps.downlink.uplink.downlinkCount` (integer) - `data.aps.downlink.uplink.extIp` (string) - `data.aps.downlink.uplink.externalPort` (string) - `data.aps.downlink.uplink.floorplanId` (string) - `data.aps.downlink.uplink.fwVersion` (string) - `data.aps.downlink.uplink.geolocationSource` (string) - `data.aps.downlink.uplink.healthStatus` (string) - `data.aps.downlink.uplink.hops` (integer) - `data.aps.downlink.uplink.isMeshEnable` (boolean) - `data.aps.downlink.uplink.isStaging` (boolean) - `data.aps.downlink.uplink.lastSeenTime` (string) - `data.aps.downlink.uplink.lastUpdTime` (string) - `data.aps.downlink.uplink.latitude` (string) - `data.aps.downlink.uplink.longitude` (string) - `data.aps.downlink.uplink.meshRole` (string) - `data.aps.downlink.uplink.model` (string) - `data.aps.downlink.uplink.name` (string) - `data.aps.downlink.uplink.neighbors` (array) - `data.aps.downlink.uplink.poePort` (string) - `data.aps.downlink.uplink.poePortStatus` (string) - `data.aps.downlink.uplink.reboot` (boolean) - `data.aps.downlink.uplink.replacedByAp` (string) - `data.aps.downlink.uplink.rogueCategory` (object) The total amount of rogue devices for each category. - `data.aps.downlink.uplink.rssi` (integer) - `data.aps.downlink.uplink.rxBytes` (string) - `data.aps.downlink.uplink.rxFrames` (string) - `data.aps.downlink.uplink.serialNumber` (string) - `data.aps.downlink.uplink.switchId` (string) - `data.aps.downlink.uplink.switchName` (string) - `data.aps.downlink.uplink.switchPort` (string) - `data.aps.downlink.uplink.switchSerialNumber` (string) - `data.aps.downlink.uplink.tags` (string) - `data.aps.downlink.uplink.tenantId` (string) - `data.aps.downlink.uplink.txBytes` (string) - `data.aps.downlink.uplink.txFrames` (string) - `data.aps.downlink.uplink.type` (integer) - `data.aps.downlink.uplink.upMac` (string) - `data.aps.downlink.uplink.uplink.rssi` (integer) - `data.aps.downlink.uplink.uplink.type` (array) - `data.aps.downlink.uplink.uplink.upMac` (string) - `data.aps.downlink.uplink.uplinkChannel` (string) - `data.aps.downlink.uplink.venueId` (string) - `data.aps.downlink.uplink.venueName` (string) - `data.aps.downlink.uplink.wlanGroup24GId` (string) - `data.aps.downlink.uplink.wlanGroup5GId` (string) - `data.aps.downlink.uplink.wlanGroups` (array) - `data.aps.downlink.uplink.xPercent` (number) - `data.aps.downlink.uplink.yPercent` (number) - `data.aps.downlink.uplinkChannel` (string) - `data.aps.downlink.venueId` (string) - `data.aps.downlink.venueName` (string) - `data.aps.downlink.wlanGroup24GId` (string) - `data.aps.downlink.wlanGroup5GId` (string) - `data.aps.downlink.wlanGroups` (array) - `data.aps.downlink.wlanGroups.radioId` (integer) - `data.aps.downlink.wlanGroups.wlanGroupId` (string) - `data.aps.downlink.wlanGroups.wlanGroupName` (string) - `data.aps.downlink.xPercent` (number) - `data.aps.downlink.yPercent` (number) - `data.aps.downlinkChannel` (string) - `data.aps.downlinkCount` (integer) - `data.aps.extIp` (string) - `data.aps.externalPort` (string) - `data.aps.floorplanId` (string) - `data.aps.fwVersion` (string) - `data.aps.geolocationSource` (string) - `data.aps.healthStatus` (string) - `data.aps.hops` (integer) - `data.aps.isMeshEnable` (boolean) - `data.aps.isStaging` (boolean) - `data.aps.lastSeenTime` (string) - `data.aps.lastUpdTime` (string) - `data.aps.latitude` (string) - `data.aps.longitude` (string) - `data.aps.meshRole` (string) - `data.aps.model` (string) - `data.aps.name` (string) - `data.aps.neighbors` (array) - `data.aps.poePort` (string) - `data.aps.poePortStatus` (string) - `data.aps.reboot` (boolean) - `data.aps.replacedByAp` (string) - `data.aps.rogueCategory` (object) The total amount of rogue devices for each category. - `data.aps.serialNumber` (string) - `data.aps.switchId` (string) - `data.aps.switchName` (string) - `data.aps.switchPort` (string) - `data.aps.switchSerialNumber` (string) - `data.aps.tags` (string) - `data.aps.tenantId` (string) - `data.aps.uplink` (array) - `data.aps.uplink.rssi` (integer) - `data.aps.uplink.type` (array) - `data.aps.uplink.upMac` (string) - `data.aps.uplinkChannel` (string) - `data.aps.venueId` (string) - `data.aps.venueName` (string) - `data.aps.wlanGroup24GId` (string) - `data.aps.wlanGroup5GId` (string) - `data.aps.wlanGroups` (array) - `data.aps.xPercent` (number) - `data.aps.yPercent` (number) - `data.groupedField` (string) - `data.groupedValue` (string) - `data.clients` (integer) - `data.deviceGroupId` (string) - `data.deviceGroupName` (string) - `data.deviceStatus` (string) - `data.incidents` (integer) - `data.members` (integer) - `data.model` (string) - `data.networks` (object) - `data.networks.count` (integer) - `data.networks.ids` (array) - `data.networks.names` (array) - `data.venueId` (string) - `errorMessage` (string) Error message if the request failed. - `errors` (array) List of detailed errors if the request encountered issues. - `errors.code` (string) Error code. - `errors.message` (string) Error message. - `errors.reason` (string) Error reason. - `errors.suggestion` (string) Error suggestion. - `fields` (array) Set of field names included in the response. - `objectId` (string) Unique identifier of the object being queried. - `page` (integer) Current page number in the paginated results. - `requestId` (string) Unique identifier for tracking this request. - `subsequentQueries` (array) List of subsequent query options for drilling down into results. - `subsequentQueries.fields` (array) - `subsequentQueries.httpMethod` (object) - `subsequentQueries.payload` (any) - `subsequentQueries.url` (string) - `totalCount` (integer) Total number of results matching the query. ## Response 400 fields ## Response 401 fields ## Response 403 fields ## Response 404 fields ## Response 422 fields ## Response 500 fields