Overview
Input types are structured objects passed as arguments to queries. For example, MetricsFilterInput lets you specify a time range and aggregation interval when querying metrics.
Input type for specifying options when querying active clients metrics.
| Field | Type | Description |
|---|
includeMeterHardware | Boolean | Whether to include meter hardware in the metrics calculation. |
Input type for specifying filters when querying all client metrics timeseries data.
| Field | Type | Description |
|---|
timeFilter | MetricsFilterInput! | Specify the time range for the timeseries data. |
| Field | Type | Description |
|---|
timeFilter | MetricsFilterInput! | Specify the time range for the timeseries data. |
Input type for specifying filters when querying client metrics timeseries data.
| Field | Type | Description |
|---|
bands | [RadioBand!] | Specifying this field returns only metrics observed for the given radio band(s). |
channels | [Int!] | Specifying this field returns only metrics observed for the given radio channel(s). |
clientMacAddresses | [MacAddress!] | Filter events by client mac. |
eventType | WirelessClientConnectionEventType | Filter events by event type. |
eventTypes | [WirelessClientConnectionEventType!] | Filter events by event type(s). |
excludeObservers | Boolean | If true, exclude events from Observers. |
partialClientMacAddresses | [String!] | Filter events by partial client mac. |
rssi | NumberRangeInput | Filter events by RSSI. |
ssidUUIDs | [UUID!] | Specifying this field returns only metrics observed for the given SSID(s), by UUID. |
timeFilter | MetricsFilterInput! | Specify the time range for the timeseries data. |
virtualDeviceUUIDs | [UUID!] | Filter events by virtual device. |
Filters the list of networks for a single company
| Field | Type | Description |
|---|
networkUUIDs | [UUID!] | Filter networks using their UUIDs. |
DevicesForNetworkFilter
Filter criteria for devices in a network.
| Field | Type | Description |
|---|
deviceType | VirtualDeviceType | Filter devices by virtual device type. |
HardwareDevicesFilter
Filters the response when fetching multiple hardware devices.
| Field | Type | Description |
|---|
deviceModel | DeviceModel | Filter hardware devices by device model. |
deviceType | DeviceType | Filter hardware devices by device type. |
limit | Int | The maximum number of hardware devices to return. Default is 200. |
offset | Int | The offset from where to start returning hardware devices. |
A range of IP addresses.
| Field | Type | Description |
|---|
end | IP! | The upper address in the IP range. |
start | IP! | The lower address in the IP range. |
| Field | Type | Description |
|---|
durationSeconds | Int! | The total duration in seconds for which to retrieve metrics data. Maximum set to 1 year. |
endTime | DateTime | If not provided, endTime defaults to now. |
stepSeconds | Int! | The interval in seconds between data points in the metrics response. |
NetworkClientsFilter
| Field | Type | Description |
|---|
apSerialNumber | String | If provided, the latest connected clients for a network are returned that were reported to be connected to the given AP serial number. At most one of macAddress, apSerialNumber, vlanID, or ssid can be provided. |
excludeMeterHardware | Boolean! | If true, clients identified as Meter hardware devices will be excluded from the results. |
includeLatency | Boolean! | If provided, then the ping latency from controller to client is included in the response. |
includeThroughput | Boolean! | If provided, the average usage for all returned clients in the last 30 minutes will be included in the response. If macAddress is provided this field has no effect. |
ipRange | IPRangeInput | If provided, returns clients with IP addresses within the provided range. |
lookbackMinutes | Int! | When no macAddress and apSerialNumber are provided, filters resulting clients' lastSeen to this many minutes before now. |
macAddress | MacAddress | If a mac address is provided, this will get the history of clients with this mac address. At most one of macAddress, apSerialNumber, vlanID, or ssid can be provided. |
ssid | String | If provided, the latest connected clients for a network are returned that were reported to be connected to the given SSID. Only supported for config 2 COS networks. At most one of macAddress, apSerialNumber, vlanID, or ssid can be provided. |
timestamp | DateTime | If provided, then returns the results that were observed at the given timestamp. If null, defaults to now. |
vlanID | Int | If provided, the latest connected clients for a network are returned that were reported to be connected to the given VLAN. Only supported for config 2 COS networks. At most one of macAddress, apSerialNumber, vlanID, or ssid can be provided. |
A number range input type.
| Field | Type | Description |
|---|
max | Int | The maximum value |
min | Int | The minimum value |
| Field | Type | Description |
|---|
isGuest | Boolean | The guest status to filter by. |
isHidden | Boolean | The hidden status to filter by. |
ssid | String | The SSID to filter by. |
Need help?
If you run into any issues or have questions, please reach out to our Support Engineering team by opening a ticket via the Dashboard: https://dashboard.meter.com/support