Types | Docs

Types

Overview

Types represent the resources you can access through the API. A type contains a list of fields, each with its own type. For example, the VLAN type has a field called name that is a String.

APChannelUtilizationTimeseriesValue

Represents a value in the timeseries of AP channel utilization metrics.

Field	Type	Description
`channel`	Int	What channel the AP's radio was on at the time of the observation. For single AP queries, this will be the most-seen channel during the bucket window. This will be null for network / multiple-AP queries (because network-level is an aggregation of all APs, which will likely be on a long list of channels).
`channelWidth`	Int	The channel width of the AP's radio at the time of the observation. For single AP queries, this will be the most-seen channel width during the bucket window. This will be null for network / multiple-AP queries (because network-level is an aggregation of all APs, which will likely be on different channel widths).
`interferenceSignalStrengthMaxdBm`	Int!	The maximum signal strength of interference sources detected on the channel. (in dBm)
`interferenceSignalStrengthMediandBm`	Int!	The median signal strength of interference sources detected on the channel. (in dBm). This is a median of medians of observations within a bucket window, floored to the nearest integer.
`interferenceSourceCountHigh`	Int!	The number of sources of high interference detected on the channel. (An average of data observations, floored to the nearest integer).
`interferenceSourceCountLow`	Int!	The number of sources of low interference detected on the channel. (An average of data observations, floored to the nearest integer).
`interferenceSourceCountMedium`	Int!	The number of sources of medium interference detected on the channel. (An average of data observations, floored to the nearest integer).
`non80211Utilization`	Float!	The amount of utilization contributed by non-802.11 interference in the environment, e.g., Bluetooth devices, cameras. (from 0 to 1)
`obssUtilization`	Float!	The amount of utilization as a result of 802.11 interference by neighboring devices. (from 0 to 1)
`rxUtilization`	Float!	The percentage of time the channel was utilized due to transmissions from clients. (from 0 to 1)
`selfUtilization`	Float!	The percentage of time the channel was utilized by the AP itself. (from 0 to 1)
`timestamp`	DateTime!	The time at which the measurement was recorded.
`totalUtilization`	Float!	The percentage of time the channel was utilized. (from 0 to 1)
`txUtilization`	Float!	The percentage of time the channel was utilized due to transmissions from the AP. (from 0 to 1)

AccessPointHardwareDevice

An access point hardware device represents a physical access point.

Field	Type	Description
`BSSIDs`	[BSSID!]!	The list of BSSIDs (Basic Service Set Identifiers) that represent unique identifiers for the access point's SSID and radio band combinations.
`createdAt`	DateTime!	The timestamp when the hardware device was first created in the system.
`deviceModel`	DeviceModel!	The model name of the hardware device.
`deviceType`	DeviceType!	The type of the hardware device.
`disconnectedFromBackendAt`	DateTime	If the device is no longer connected to the backend, this is the time at which it was last connected.
`ipAddress`	String	The IP address of the access point hardware device.
`isConnectedToBackend`	Boolean!	Indicates whether the hardware device is connected to the backend.
`isSpare`	Boolean!	A spare hardware device belongs to a network but not a virtual device. Used most often to keep track of spare hardware we ship to a customer but don't install immediately.
`macAddress`	MacAddress	The MAC address of the hardware device.
`networkUUID`	UUID	The UUID of the network that the hardware device belongs to.
`phyInterfaceConnectedTo`	PhyInterface	The physical interface (on a Meter Switch) that the access point is connected to, if applicable.
`serialNumber`	String!	The unique serial number of the hardware device.
`updatedAt`	DateTime!	The timestamp when the hardware device was last updated in the system.
`virtualDevice`	VirtualDevice	The virtual device associated with this hardware device, if any.
`virtualDeviceUUID`	UUID	The UUID of the virtual device this hardware device is assigned to, if any.

AccessPointHealthScores

An individual Access Point's health scores.

Field	Type	Description
`beaconScore2G`	Int!	The beacon score on the 2G radio band of the device.
`beaconScore5G`	Int!	The beacon score on the 5G radio band of the device.
`beaconScore6G`	Int!	The beacon score on the 6G radio band of the device.
`connectionAttempts2G`	Int!	The number of connection attempts on the 2G radio band of the device.
`connectionAttempts5G`	Int!	The number of connection attempts on the 5G radio band of the device.
`connectionAttempts6G`	Int!	The number of connection attempts on the 6G radio band of the device.
`connectionScore`	Int!	This represents the quality and stability of connections between the device and its clients.
`connectionScore2G`	Int!	The connection score on the 2G radio band of the device.
`connectionScore5G`	Int!	The connection score on the 5G radio band of the device.
`connectionScore6G`	Int!	The connection score on the 6G radio band of the device.
`connectionSuccess2G`	Int!	The number of successful connections on the 2G radio band of the device.
`connectionSuccess5G`	Int!	The number of successful connections on the 5G radio band of the device.
`connectionSuccess6G`	Int!	The number of successful connections on the 6G radio band of the device.
`coverageScore2G`	Int!	The coverage score on the 2G radio band of the device.
`coverageScore5G`	Int!	The coverage score on the 5G radio band of the device.
`coverageScore6G`	Int!	The coverage score on the 6G radio band of the device.
`dhcpAttempts2G`	Int!	The number of DHCP attempts on the 2G radio band of the device.
`dhcpAttempts5G`	Int!	The number of DHCP attempts on the 5G radio band of the device.
`dhcpAttempts6G`	Int!	The number of DHCP attempts on the 6G radio band of the device.
`dhcpSuccess2G`	Int!	The number of successful DHCP completions on the 2G radio band of the device.
`dhcpSuccess5G`	Int!	The number of successful DHCP completions on the 5G radio band of the device.
`dhcpSuccess6G`	Int!	The number of successful DHCP completions on the 6G radio band of the device.
`freeCPUPercentage`	Int!	The percentage of CPU available on the device.
`freeMemoryPercentage`	Int!	The percentage of memory available on the device.
`mcsScore2G`	Int!	The MCS (Modulation and Coding Scheme) score on the 2G radio band of the device.
`mcsScore5G`	Int!	The MCS (Modulation and Coding Scheme) score on the 5G radio band of the device.
`mcsScore6G`	Int!	The MCS (Modulation and Coding Scheme) score on the 6G radio band of the device.
`numClients2G`	Int!	The number of clients on a 2G radio band.
`numClients5G`	Int!	The number of clients on a 5G radio band.
`numClients6G`	Int!	The number of clients on a 6G radio band.
`overallScore`	Int!	The total score, which is an aggregate of the other scores.
`overallScore2G`	Int!	The overall score on the 2G radio band of the device.
`overallScore5G`	Int!	The overall score on the 5G radio band of the device.
`overallScore6G`	Int!	The overall score on the 6G radio band of the device.
`performanceScore`	Int!	This represents the overall throughput, latency, etc. of the device.
`performanceScore2G`	Int!	This performance score on the 2G radio band of the device.
`performanceScore5G`	Int!	This performance score on the 5G radio band of the device.
`performanceScore6G`	Int!	This performance score on the 6G radio band of the device.
`retryScore2G`	Int!	The retry score on the 2G radio band of the device.
`retryScore5G`	Int!	The retry score on the 5G radio band of the device.
`retryScore6G`	Int!	The retry score on the 6G radio band of the device.
`rfScore`	Int!	The score of the device's wireless environment (interference, noise, etc.).
`rfScore2G`	Int!	The rf score on the 2G radio band of the device.
`rfScore5G`	Int!	The rf score on the 5G radio band of the device.
`rfScore6G`	Int!	The rf score on the 6G radio band of the device.
`systemScore`	Int!	The score of the system (CPU, memory, etc) of the device.
`timestamp`	DateTime!	The timestamp when the health scores were last updated.

AccessPointVirtualDevice

An access point virtual device is a logical representation of a physical access point.

Field	Type	Description
`UUID`	UUID!	The unique identifier (UUID) of the virtual device.
`connectedClients`	[WirelessClient!]!	The wireless clients that are currently connected to the access point.
`createdAt`	DateTime!	The timestamp when the virtual device was first created in the system.
`description`	String	An optional description for the virtual device.
`deviceModel`	DeviceModel!	The model name of the virtual device.
`deviceType`	VirtualDeviceType!	The type of the virtual device.
`hardwareDevice`	HardwareDevice	The hardware device associated with this virtual device, if any.
`isOnline`	Boolean!	Indicates whether the hardware device is online, indicated by its heartbeat.
`label`	String!	A human-friendly name for the device.
`networkUUID`	UUID!	The unique identifier (UUID) of the network the virtual device belongs to.
`radioProfile`	RadioProfile	The radio profile associated with this access point.
`radioProfileUUID`	UUID	The UUID of the radio profile associated with this access point.
`radioSettings`	RadioSettings!	The radio settings (channel, power) specific to this access point.
`ssids`	[SSID!]!	All of the enabled SSIDs (Service Set Identifiers) that the access point is broadcasting.
`tags`	[VirtualDeviceTag!]	The virtual device tags on this access point.
`updatedAt`	DateTime!	The timestamp when the virtual device was last updated in the system.

ActiveClientsMetricsResponse

Response type containing active clients metrics over a specified time range.

Field	Type	Description
`wired`	[ActiveClientsMetricsValue!]!	A list of wired active clients metrics values.
`wireless`	[ActiveClientsMetricsValue!]!	A list of wireless active clients metrics values.

ActiveClientsMetricsValue

Represents a single data point for the number of active clients at a given timestamp.

Field	Type	Description
`timestamp`	DateTime!	The timestamp of the metric data point.
`value`	Float!	The number of active clients at the given timestamp.

AlertReceiver

An alert receiver is called when an alert is triggered.

Field	Type	Description
`UUID`	UUID!	Unique identifier for the alert receiver.
`companyUUID`	UUID!	Unique identifier of the company that owns this alert receiver.
`createdAt`	DateTime!	Timestamp when the alert receiver was created.
`deletedAt`	DateTime	Timestamp when the alert receiver was deleted (null if not deleted).
`label`	String!	Descriptive label for the alert receiver.
`targets`	[AlertTarget!]!	List of alert targets associated with this alert receiver.
`updatedAt`	DateTime!	Timestamp when the alert receiver was last updated.

AlertTarget

An interface representing a target to which alerts can be sent. This can be implemented by different types of alert targets, such as email or webhook.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the alert target.
`companyUUID`	UUID!	The unique identifier of the company that owns the alert target.
`createdAt`	DateTime!	The timestamp when the alert target was created.
`deletedAt`	DateTime	The timestamp when the alert target was deleted, if applicable.
`type`	AlertTargetType!	The type of the alert target.
`updatedAt`	DateTime!	The timestamp when the alert target was last updated.

AlertTargetEmail

An email alert target that implements the AlertTarget interface. Used to send alerts to a specified email address.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the email alert target.
`companyUUID`	UUID!	The unique identifier of the company that owns the email alert target.
`createdAt`	DateTime!	The timestamp when the email alert target was created.
`deletedAt`	DateTime	The timestamp when the email alert target was deleted, if applicable.
`emailAddress`	String!	The email address to which alerts will be sent.
`type`	AlertTargetType!	The type of the alert target, this should always be EMAIL.
`updatedAt`	DateTime!	The timestamp when the email alert target was last updated.

AlertTargetSalesforce

An alert target that implements the AlertTarget interface. Used to send alerts to a specified salesforce instance.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the salesforce alert target.
`companyUUID`	UUID!	The unique identifier of the company that owns the salesforce alert target.
`createdAt`	DateTime!	The timestamp when the salesforce alert target was created.
`deletedAt`	DateTime	The timestamp when the salesforce alert target was deleted, if applicable.
`domain`	String!	The domain of the salesforce instance
`type`	AlertTargetType!	The type of the alert target, this should always be SLACK.
`updatedAt`	DateTime!	The timestamp when the salesforce alert target was last updated.

AlertTargetSlack

An alert target that implements the AlertTarget interface. Used to send alerts to a specified slack channel.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the slack alert target.
`channelID`	String!	The Slack channel ID to which alerts will be sent.
`companyUUID`	UUID!	The unique identifier of the company that owns the slack alert target.
`createdAt`	DateTime!	The timestamp when the slack alert target was created.
`deletedAt`	DateTime	The timestamp when the slack alert target was deleted, if applicable.
`label`	String	The label of the slack alert target.
`type`	AlertTargetType!	The type of the alert target, this should always be SLACK.
`updatedAt`	DateTime!	The timestamp when the slack alert target was last updated.

AlertTargetWebhook

A webhook alert target that implements the AlertTarget interface. Used to send alerts to a specified webhook URL.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the webhook alert target.
`companyUUID`	UUID!	The unique identifier of the company that owns the webhook alert target.
`createdAt`	DateTime!	The timestamp when the webhook alert target was created.
`deletedAt`	DateTime	The timestamp when the webhook alert target was deleted, if applicable.
`label`	String	An optional label for the webhook alert target.
`type`	AlertTargetType!	The type of the alert target, indicating that it is a webhook.
`updatedAt`	DateTime!	The timestamp when the webhook alert target was last updated.
`url`	String!	The URL endpoint of the webhook where alerts will be sent.

AllClientMetricsTimeseriesResponse

Response type containing client metrics timeseries data over a specified time range.

Field	Type	Description
`rxBytes`	BaseMetricsResponse!	Aggregated data for the total bytes received.
`txBytes`	BaseMetricsResponse!	Aggregated data for the total bytes transmitted.

ApplicationDNSFirewallRuleApplication

The application associated with a DNS firewall rule as specified by Netstar.

Field	Type	Description
`id`	Int!	The unique identifier of the application.
`name`	String!	The name of the application.

BSSID

BSSID represents a unique identifier for a wireless network, in the form of a MAC address. Every radio band / SSID pair for an AP has its own BSSID, derived from the hardware device's MAC address.

Field	Type	Description
`BSSID`	MacAddress!	The MAC address uniquely identifying this BSSID on the wireless network.
`SSID`	SSID!	The SSID object associated with this BSSID.
`SSIDUUID`	UUID!	The UUID of the SSID associated with this BSSID.
`accessPointHardwareDevice`	AccessPointHardwareDevice!	The hardware device representing the access point associated with this BSSID.
`accessPointSerialNumber`	String!	The serial number of the access point associated with this BSSID.
`isActive`	Boolean!	A BSSID is inactive if it is associated with a disabled SSID, or the SSID is not broadcast for its AP, or the SSID is not allowed for its radio band, or the radio band is disabled on its AP's radio profile.
`radioBand`	RadioBand!	The radio frequency band on which this BSSID operates.

Base64Image

Base64 encoded image data.

Field	Type	Description
`data`	String!	The base64 encoded image data.
`imageType`	ImageType!	The type of the image.

BaseMetricsResponse

Base implementation of MetricsValue that provides no more fields.

Field	Type	Description
`metadata`	MetricsMetadata	Metadata providing additional information about the metrics data.
`values`	[BaseMetricsValue!]!	The list of metrics data points.

BaseMetricsValue

Base implementation of MetricsValue that provides no more fields.

Field	Type	Description
`timestamp`	DateTime!	The timestamp for this metrics data point.
`value`	Float!	The value of the metric at the given timestamp.

CaptivePortal

A captive portal is a web page that is displayed to newly connected users before allowing them access to the network.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the captive portal.
`allowedHosts`	[String!]!	Whitelisted IPs/URLs that are allowed on the network by default.
`authLifetimeSec`	Int	Authentication session duration in seconds. The amount of time a user remains authorized after accepting the terms and conditions. Defaults to 1 day (86400 seconds) if not set.
`callToAction`	String	The heading to display on the captive portal page.
`displaySettings`	CaptivePortalDisplaySettings	Display settings for the captive portal page, including background and font colors and whether to hide the 'Powered by Meter' text.
`isEnabled`	Boolean!	If true, the captive portal is enabled.
`logoImageBase64`	Base64Image	A base64 encoded image of the logo. This is used to limit the number of domains we need to allow for the logo image.
`logoImageURL`	String	A URL to a logo image that will be displayed on the captive portal page.
`name`	String	A human-friendly name for the captive portal.
`networkUUID`	UUID!	The UUID of the network to which this captive portal belongs.
`redirectURL`	String	The URL to redirect to after a successful captive portal login.
`requiresApproval`	Boolean!	If true, captive portal auth requests will need to be approved by an admin.
`requiresEmail`	Boolean!	If true, the captive portal will collect email addresses from users.
`requiresName`	Boolean!	If true, the captive portal will collect names from users.
`termsAndConditions`	String	The terms and conditions text that a user must agree to before accessing the network.
`vlans`	[VLAN!]	The VLANs that this captive portal is associated with.

CaptivePortalDisplaySettings

Display settings for the captive portal page.

Field	Type	Description
`backgroundColor`	String	The background color of the captive portal page, specified as a hex color code.
`callToActionColor`	String	The color used on the call to action, specified as a hex color code.
`fontColor`	String	The font color used on the captive portal page, specified as a hex color code.
`hidePoweredByMeter`	Boolean	If true, the 'Powered by Meter' text will be hidden on the captive portal page.

CaptivePortalEntry

Recorded entry of an auth request for a captive portal.

Field	Type	Description
`UUID`	UUID!	The UUID of the captive portal entry.
`actionedBy`	User	User that performed the latest action on the captive portal entry.
`approvedAt`	DateTime	Timestamp when the captive portal request was approved.
`createdAt`	DateTime!	Timestamp when the captive portal entry was created.
`deletedAt`	DateTime	Timestamp when the captive portal entry data was deleted.
`deniedAt`	DateTime	Timestamp when the captive portal request was denied.
`email`	String	The email address collected from the client.
`ip`	IP	The ip address of the client.
`mac`	MacAddress	The mac address of the client.
`name`	String	The name collected from the client.
`networkUUID`	UUID!	The UUID of the network.

CaptivePortalEntryPage

A page of captive portal entries.

Field	Type	Description
`entries`	[CaptivePortalEntry!]!	The list of captive portal entries.
`total`	Int!	The total number of captive portal entries.

ChannelUtilizationResponseV2

Response type containing timeseries of channel utilization metrics.

Field	Type	Description
`band`	RadioBand!	The radio band (e.g., 2.4 GHz, 5 GHz) for which the data is provided.
`values`	[APChannelUtilizationTimeseriesValue!]!	List of timeseries values of channel utilization metrics.
`virtualDeviceUUID`	UUID!	The unique identifier of the virtual device (AP) from which the data originates.

ClientChannelUtilizationTimeseriesValue

Represents a single data point of channel utilization metrics for a client.

Field	Type	Description
`non80211Utilization`	Float!	The amount of utilization contributed by non-802.11 interference in the environment, e.g., Bluetooth, cameras (from 0 to 1).
`obssUtilization`	Float!	The amount of utilization due to 802.11 interference by neighboring networks (from 0 to 1).
`rxUtilization`	Float!	The percentage of time the channel was utilized due to receptions from clients (from 0 to 1).
`selfUtilization`	Float!	The percentage of time the channel was utilized by the AP itself (from 0 to 1).
`timestamp`	DateTime!	The timestamp of the metric data point.
`totalUtilization`	Float!	The percentage of time the channel was utilized (from 0 to 1).
`txUtilization`	Float!	The percentage of time the channel was utilized due to transmissions from the AP (from 0 to 1).

ClientMetricsMetadata

Aggregated values (like min/max) over the given time range for all of the client metrics requested.

Field	Type	Description
`associationTimeSeconds`	MetricsMetadata	Aggregated metadata for the association time in seconds
`clientCount`	MetricsMetadata	Aggregated metadata for the client count
`hwMode`	MetricsMetadata	Aggregated metadata for the hardware mode of the client device.
`noise`	MetricsMetadata	Aggregated metadata for the noise level in dBm.
`numSpatialStreamsRx`	MetricsMetadata	Aggregated metadata for the number of receive spatial streams.
`numSpatialStreamsTx`	MetricsMetadata	Aggregated metadata for the number of transmit spatial streams.
`rxBytes`	MetricsMetadata	Aggregated metadata for the total bytes received.
`rxMulticastBytes`	MetricsMetadata	Aggregated metadata for the multicast bytes received.
`rxRate`	MetricsMetadata	Aggregated metadata for the receive rate in kilobits per second.
`rxUnicastBytes`	MetricsMetadata	Aggregated metadata for the unicast bytes received.
`signal`	MetricsMetadata	Aggregated metadata for the signal strength in dBm.
`snr`	MetricsMetadata	Aggregated metadata for the signal-to-noise ratio in dB.
`txBytes`	MetricsMetadata	Aggregated metadata for the total bytes transmitted.
`txMulticastBytes`	MetricsMetadata	Aggregated metadata for the multicast bytes transmitted.
`txRate`	MetricsMetadata	Aggregated metadata for the transmit rate in kilobits per second.
`txUnicastBytes`	MetricsMetadata	Aggregated metadata for the unicast bytes transmitted.

ClientMetricsTimeseriesResponse

Response type containing client metrics timeseries data over a specified time range.

Field	Type	Description
`metadata`	ClientMetricsMetadata	Aggregated metadata for the client metrics timeseries.
`values`	[ClientMetricsTimeseriesValue!]!	A list of client metrics timeseries values.

ClientMetricsTimeseriesValue

Time-series data for client connectivity metrics. If requested at a per-AP level, the results will be aggregated over all clients connected to the AP.

Field	Type	Description
`clientCount`	Int!	The count of distinct clients (by MAC address) that connected to the AP during the time period.
`hwMode`	String	The Wi-Fi capabilities of the client device.
`noise`	Float!	Noise level in dBm.
`numSpatialStreamsRx`	Int	The number of receive spatial streams.
`numSpatialStreamsTx`	Int	The number of transmit spatial streams.
`rxBytes`	Float!	Total number of bytes received in the given time period.
`rxMulticastBytes`	Float!	Total number of multicast bytes received in the given time period; a subset of `rxBytes`.
`rxRate`	Float!	The rate at which the client is receiving data in kilobits per second.
`rxRetryRatio`	Float	The ratio of the number of times a packet was retried to the total number of successful packets. Null if no packets succeeded.
`rxUnicastBytes`	Float!	Total number of unicast bytes received in the given time period; a subset of `rxBytes`.
`signal`	Float!	Received signal strength in dBm.
`snr`	Float!	Signal-to-noise ratio in dB. A higher value is better. SNR = signal - noise.
`timestamp`	DateTime!	The timestamp of the metric data point.
`txBytes`	Float!	Total number of bytes transmitted in the given time period.
`txMulticastBytes`	Float!	Total number of multicast bytes transmitted in the given time period; a subset of `txBytes`.
`txRate`	Float!	The rate at which the client is transmitting data in kilobits per second.
`txRetryRatio`	Float	The ratio of the number of times the client retried a packet transmission to the number of packets successfully transmitted. Null if no packets were transmitted.
`txSuccessRatio`	Float	The ratio of the number of times the client successfully received a packet to the number of packets transmitted. Null if no packets were transmitted.
`txUnicastBytes`	Float!	Total number of unicast bytes transmitted in the given time period; a subset of `txBytes`.

Company

A company is a core Meter entity used to represent customers. Networks belong to companies.

Field	Type	Description
`isCustomer`	Boolean!	A company representing a Meter customer as opposed to an internal (test) company.
`name`	String!	The name of the company.
`networks`	[Network!]!	The networks associated with this company.
`onboardingDocument`	CompanyOnboardingDocument	Onboarding document form completed prior to network going live. Different from `onboarding`.
`slug`	String!	A unique, URL-friendly identifier for the company, used in APIs and URLs.
`uuid`	UUID!	The unique UUID identifier for the company.
`websiteDomain`	String	The company's website domain if applicable. This is set by the Salesforce -> Backend data sync process.

CompanyOnboardingDocument

Document containing information required for company onboarding.

Field	Type	Description
`UUID`	UUID!	Unique identifier for the company onboarding document.
`companyUUID`	UUID!	Unique identifier of the associated company.
`createdAt`	DateTime!	Timestamp when the document was created.
`delegations`	[CompanyOnboardingFieldDelegation!]!	List of fields that have been delegated to other users for completion.
`document`	JSONObject!	JSON object containing the onboarding document data.
`documentMetadata`	JSONObject	JSON object containing the onboarding document metadata data.
`updatedAt`	DateTime!	Timestamp when the document was last updated.

CompanyOnboardingFieldDelegation

Represents the delegation of a specific field of the company onboarding document to a user.

Field	Type	Description
`UUID`	UUID!	Unique identifier of the field delegation.
`companyUUID`	UUID!	Unique identifier of the associated company.
`description`	String	Description of the delegation.
`email`	String!	Email of the user to whom the field is delegated.
`fieldName`	String!	Name of the field being delegated.

ControllerDNSRequestRatesResponse

Response containing an array of DNS request rate values.

Field	Type	Description
`values`	[ControllerDNSRequestRatesValue!]!	Array of DNS request rate values per timestamp and DNS server UUID.

ControllerDNSRequestRatesValue

Metrics data point containing DNS request rates for a controller's DNS server.

Field	Type	Description
`timestamp`	DateTime!	Timestamp for the metrics data point.
`uuid`	UUID!	UUID of the DNS server.
`value`	Float!	Requests per second.

ControllerHardwareDevice

A controller hardware device represents a physical firewall (aka security appliance aka controller).

Field	Type	Description
`createdAt`	DateTime!	The timestamp when the hardware device was first created in the system.
`deviceModel`	DeviceModel!	The model name of the hardware device.
`deviceType`	DeviceType!	The type of the hardware device.
`disconnectedFromBackendAt`	DateTime	If the device is no longer connected to the backend, this is the time at which it was last connected.
`isConnectedToBackend`	Boolean!	Indicates whether the hardware device is connected to the backend.
`isSpare`	Boolean!	A spare hardware device belongs to a network but not a virtual device. Used most often to keep track of spare hardware we ship to a customer but don't install immediately.
`macAddress`	MacAddress	The MAC address of the hardware device.
`networkUUID`	UUID	The UUID of the network that the hardware device belongs to.
`serialNumber`	String!	The unique serial number of the hardware device.
`updatedAt`	DateTime!	The timestamp when the hardware device was last updated in the system.
`virtualDevice`	VirtualDevice	The virtual device associated with this hardware device, if any.
`virtualDeviceUUID`	UUID	The UUID of the virtual device this hardware device is assigned to, if any.

ControllerPortMetricsRateResponse

Response object containing an array of controller port metrics rate values.

Field	Type	Description
`values`	[ControllerPortMetricsRateValue!]!	Array of metrics rate values per timestamp and port.

ControllerPortMetricsRateValue

Metrics data point containing rate statistics (per second) for a controller port over a specific time interval.

Field	Type	Description
`broadcastRxPacketsPerSecond`	Float!	Total number of broadcast packets per second received during the time interval; a subset of totalRxPackets.
`broadcastTxPacketsPerSecond`	Float!	Total number of broadcast packets per second transmitted during the time interval; a subset of totalTxPackets.
`dropsPerSecond`	Float!	The number of packets per second that were dropped during the time interval.
`multicastRxPacketsPerSecond`	Float!	Total number of multicast packets per second received during the time interval; a subset of totalRxPackets.
`multicastTxPacketsPerSecond`	Float!	Total number of multicast packets per second transmitted during the time interval; a subset of totalTxPackets.
`portNumber`	Int!	The physical port number on the controller.
`rxErrPerSecond`	Float!	The number of packets per second that encountered errors being received in the time interval.
`timestamp`	DateTime!	Timestamp for the metrics data point.
`totalRxBytesPerSecond`	Float!	Total number of bytes per second received during the time interval.
`totalTxBytesPerSecond`	Float!	Total number of bytes per second transmitted during the time interval.
`txErrPerSecond`	Float!	The number of packets per second that encountered errors during transmission in the time interval.

ControllerPortStat

Summed stats (unless otherwise specified) per controller port over a lookback period.

Field	Type	Description
`broadcastRxBytes`	Int!	Total number of broadcast bytes received in the given time period; a subset of totalRxBytes.
`broadcastRxPackets`	Int!	Total number of broadcast packets received in the given time period; a subset of totalRxPackets.
`broadcastTxBytes`	Int!	Total number of broadcast bytes transmitted in the given time period; a subset of totalTxBytes.
`broadcastTxPackets`	Int!	Total number of broadcast packets transmitted in the given time period; a subset of totalTxPackets.
`drops`	Int!	The number of packets that were dropped in the time interval.
`hwUp`	Boolean!	Most recent hardware up state. Indicates that a physical connection is established, typically meaning a cable is properly connected and active.
`ipv4`	Int!	The number of IPv4 packets transmitted or received.
`ipv6`	Int!	The number of IPv6 packets transmitted or received.
`multicastRxBytes`	Int!	Total number of multicast bytes received in the given time period; a subset of totalRxBytes.
`multicastRxPackets`	Int!	Total number of multicast packets received in the given time period; a subset of totalRxPackets.
`multicastTxBytes`	Int!	Total number of multicast bytes transmitted in the given time period; a subset of totalTxBytes.
`multicastTxPackets`	Int!	Total number of multicast packets transmitted in the given time period; a subset of totalTxPackets.
`portNumber`	Int!	The physical port number on the controller.
`punts`	Int!	The number of packets punted to the CPU for processing (currently not reported by firmware).
`rxErr`	Int!	The number of packets that encountered errors being received.
`totalRxBytes`	Int!	Total number of bytes received in the given time period.
`totalRxPackets`	Int!	Total number of packets received in the given time period.
`totalTxBytes`	Int!	Total number of bytes transmitted in the given time period.
`totalTxPackets`	Int!	Total number of packets transmitted in the given time period.
`txErr`	Int!	The number of packets that encountered errors during transmission.
`unicastRxBytes`	Int!	Total number of unicast bytes received in the given time period; a subset of totalRxBytes.
`unicastRxPackets`	Int!	Total number of unicast packets received in the given time period; a subset of totalRxPackets.
`unicastTxBytes`	Int!	Total number of unicast bytes transmitted in the given time period; a subset of totalTxBytes.
`unicastTxPackets`	Int!	Total number of unicast packets transmitted in the given time period; a subset of totalTxPackets.

ControllerVirtualDevice

A controller virtual device is a logical representation of a physical firewall (aka security appliance aka controller).

Field	Type	Description
`UUID`	UUID!	The unique identifier (UUID) of the virtual device.
`createdAt`	DateTime!	The timestamp when the virtual device was first created in the system.
`description`	String	An optional description for the virtual device.
`deviceModel`	DeviceModel!	The model name of the virtual device.
`deviceType`	VirtualDeviceType!	The type of the virtual device.
`hardwareDevice`	HardwareDevice	The hardware device associated with this virtual device, if any.
`isOnline`	Boolean!	Indicates whether the hardware device is online, indicated by its heartbeat.
`label`	String!	A human-friendly name for the device.
`networkUUID`	UUID!	The unique identifier (UUID) of the network the virtual device belongs to.
`updatedAt`	DateTime!	The timestamp when the virtual device was last updated in the system.
`uptime`	Duration	The uptime from our time series database for the device.

Coordinates

Represents geographical coordinates with latitude and longitude.

Field	Type	Description
`latitude`	Float!	The latitude component of the coordinates.
`longitude`	Float!	The longitude component of the coordinates.

DHCPRule

Stores specific information about a DHCP server for a specific interface, equivalent to a Kea 'subnet'.

Field	Type	Description
`dnsUpstreamServers`	[IP!]!	List of upstream DNS servers to use when `dnsUseGatewayProxy` is `false`, or to forward queries to when enabled.
`dnsUseGatewayProxy`	Boolean!	Determines if the gateway acts as a DNS proxy for clients. If `true`, DNS queries are sent via the gateway.
`endIPAddress`	IP	The last available IP address in the DHCP range, ascending and inclusive. Omitted if DHCP is not being served.
`gatewayIPAddress`	IP!	The gateway IP address provided to DHCP clients (commonly known as the router option or DHCP option 3).
`gatewayPrefixLength`	Int!	The prefix length of the gateway IP address (e.g., 24 for a subnet mask of 255.255.255.0 in IPv4).
`startIPAddress`	IP	The first available IP address in the DHCP range, ascending and inclusive. Omitted if DHCP is not being served.

Encryption8021X

Represents the 802.1X encryption configuration for an SSID.

Field	Type	Description
`UUID`	UUID!	The unique identifier of this 802.1X encryption configuration.
`accountingServerIPAddress`	IP	The IP address of the accounting server.
`accountingServerPort`	Int	The port of the accounting server.
`authServerIPAddress`	IP!	The IP address of the authentication server.
`authServerPort`	Int!	The port of the authentication server.
`isRadiusPollerEnabled`	Boolean!	Enable RadiusPoller to query this profile for uptime
`label`	String!	A user-friendly label for the encryption configuration.
`networkUUID`	UUID!	The UUID of the network to which this encryption configuration belongs.
`ssids`	[SSID!]	The SSIDs associated with this 802.1X encryption configuration.

EventLogEvent

An event in the event log.

Field	Type	Description
`eventType`	EventType!	The type of event.
`eventTypeAPIName`	String!	The API name representation of the event type.
`generatedAt`	DateTime!	The timestamp when the event was generated.
`insertedAt`	DateTime!	The timestamp when the event was inserted into the database.
`networkUUID`	UUID!	The UUID of the network where the event occurred.

EventLogEventsPage

A paged response for event log queries.

Field	Type	Description
`events`	[EventLogEvent!]!	A subset of records based on the limit and offset fields
`total`	Int!	The total number of records

FirewallRule

Represents a firewall rule in the network configuration.

Field	Type	Description
`UUID`	UUID!	Unique identifier for the firewall rule.
`action`	FirewallRuleAction!	The action to take when the firewall rule matches (e.g., DENY or PERMIT).
`createdAt`	DateTime!	The date and time when the firewall rule was created.
`description`	String	A description of the firewall rule.
`dstPortRanges`	[PortRange!]!	List of destination port ranges to match traffic to.
`dstPrefix`	IPPrefix	Destination IP prefix to match traffic to.
`isEnabled`	Boolean!	Indicates if the firewall rule is currently enabled.
`name`	String!	The name of the firewall rule.
`network`	Network!	The network to which the firewall rule belongs.
`networkUUID`	UUID!	Unique identifier of the network to which the firewall rule belongs.
`priority`	Int!	Priority of the rule within the network, lower priority rules are applied first.
`protocols`	[IPProtocol!]!	List of IP protocols to match.
`srcPortRanges`	[PortRange!]!	List of source port ranges to match traffic from.
`srcPrefix`	IPPrefix	Source IP prefix to match traffic from.
`tags`	[String!]	List of tags associated with the firewall rule.
`updatedAt`	DateTime!	The date and time when the firewall rule was last updated.

FloorPlan

A floor plan is an overhead view of a physical space. A floor plan is one-to-many to floor plan locations, which are x/y coordinates for Meter devices in the physical space.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the floor plan.
`createdAt`	DateTime!	The timestamp when the floor plan was created.
`description`	String	A description of the floor plan.
`documentCategory`	FloorPlanDocumentCategory!	The type of the document.
`imageDownloadURL`	String!	A pre-signed URL to download the floor plan image.
`label`	String!	A human-readable name or label for the floor plan.
`networkUUID`	UUID!	The unique identifier of the network that this floor plan belongs to.
`updatedAt`	DateTime!	The timestamp when the floor plan was last updated.

HardwareDevice

A hardware device represents a physical device.

Field	Type	Description
`createdAt`	DateTime!	The timestamp when the hardware device was first created.
`deviceModel`	DeviceModel!	The model name of the hardware device.
`deviceType`	DeviceType!	The type of the hardware device.
`disconnectedFromBackendAt`	DateTime	If the device is no longer connected to the backend, this is the time at which it was last connected.
`isConnectedToBackend`	Boolean!	Indicates whether the hardware device is connected to the backend.
`isSpare`	Boolean!	A spare hardware device belongs to a network but not a virtual device. Used most often to keep track of spare hardware we ship to a customer but don't install immediately.
`macAddress`	MacAddress	The MAC address of the hardware device.
`networkUUID`	UUID	The UUID of the network that the hardware device belongs to.
`serialNumber`	String!	The unique serial number of the hardware device.
`updatedAt`	DateTime!	The timestamp when the hardware device was last updated.
`virtualDevice`	VirtualDevice	The virtual device associated with this hardware device, if any.
`virtualDeviceUUID`	UUID	The UUID of the virtual device this hardware device is assigned to, if any.

HoneypotBroadcaster

A honeypot broadcaster is the actual device that is observed broadcasting the SSID.

Field	Type	Description
`bssid`	MacAddress!	The BSSID of the honeypot.
`observers`	[NetworkThreatObserver!]!	The devices that were able to observe the honeypot.

HoneypotSSID

A honeypot is an SSID that is being broadcasted which matches the name of a known SSID.

Field	Type	Description
`broadcasters`	[HoneypotBroadcaster!]!	The devices that are broadcasting the SSID.
`network`	Network!	The network that the honeypot was observed on.
`networkUUID`	UUID!	The unique identifier network that the honeypot was observed on.
`ssid`	String!	The SSID of the honeypot.

IDSEvent

An instance of an IDS event found by suricata. Full documentation can be found at https://docs.suricata.io/en/latest/output/eve/eve-json-format.html.

Field	Type	Description
`alert`	IDSEventAlert	Alert for the event.
`appProto`	String	When application layer protocol event is detected.
`direction`	IDSEventDirection!	Direction for this event.
`dstIP`	IP	The destination IP of this event.
`dstLocation`	IDSEventLocation	The destination location of this event, derived from dstIP.
`dstMAC`	MacAddress	The destination MAC address of this event.
`dstPort`	Int!	The destination port of this event.
`flow`	IDSEventFlowInfo	Flow info for the event.
`flowID`	Int!	Correlates the network protocol, flow logs EVE data and any evidence that Suricata has logged to an alert event and that alert's metadata, as well as to fileinfo/file transaction and anomaly logs, if available.
`httpInfo`	IDSEventHTTPInfo	HTTP info for the event.
`ipsRule`	IDSEventIPSRule	IPS rule, only populated if IPS is enabled.
`observedAt`	DateTime!	When this event was observed.
`protocol`	IDSEventProtocol!	Network protocol for this event.
`srcIP`	IP	The source IP of this event.
`srcLocation`	IDSEventLocation	The source location of this event, derived from srcIP.
`srcMAC`	MacAddress	The source MAC address of this event.
`srcPort`	Int!	The source port of this event.
`timestamp`	DateTime!	Timestamp of this event. If not provided, value is filled by observed_at from stats.
`tlsInfo`	IDSEventTLSInfo	TLS info for the event.
`type`	IDSEventType!	The log type.
`virtualDevice`	VirtualDevice!	Virtual device that observed this event.

IDSEventAlert

https://docs.suricata.io/en/latest/output/eve/eve-json-format.html#event-type-alert

Field	Type	Description
`action`	IDSEventAlertAction!	Action for the alert.
`category`	String!	Category of the alert.
`gid`	Int!	Group ID of the alert.
`idsRule`	IDSRule	The rule that triggered this event.
`rev`	Int!	Revision of the alert.
`severity`	Int!	The severity of the alert.
`sid`	Int!	Signature ID of the alert.
`signature`	String!	The signature of the alert.

IDSEventFlowInfo

https://docs.suricata.io/en/latest/output/eve/eve-json-format.html#event-type-flow

Field	Type	Description
`bytesToClient`	Int!	Total bytes count to client.
`bytesToServer`	Int!	Total bytes count to server.
`end`	DateTime	Date of end of flow (last seen packet)
`packetsToClient`	Int!	Total number of packets to client.
`packetsToServer`	Int!	Total number of packets to server, include bypassed packets.
`reason`	String	Mechanism that did trigger the end of the flow (include "timeout", "forced" and "shutdown").
`start`	DateTime	Date of start of the flow

IDSEventHTTPInfo

https://docs.suricata.io/en/latest/output/eve/eve-json-format.html#event-type-http

Field	Type	Description
`contentType`	String!	The type of data returned (ex: application/x-gzip).
`hostname`	String!	The hostname this HTTP event is attributed to.
`length`	Int!	The content size of the HTTP body.
`protocol`	String!	Protocol / Version of HTTP (ex: HTTP/1.1).
`status`	Int!	HTTP status code.
`url`	String!	URL at the hostname that was accessed.
`userAgent`	String!	The user-agent of the software that was used.

IDSEventIPSRule

Details a firewall rule created by IPS.

Field	Type	Description
`UUID`	UUID!	Unique identifier for the IPS rule.
`dstPortRange`	PortRange!	Destination port range to match traffic from.
`dstPrefix`	IPPrefix!	Destination IP prefix to match traffic from.
`durationSec`	Int!	Validity from timestamp; 0 = always valid
`phyInterfaceBindings`	[PhyInterface!]	Uplink phy interface bound to this rule.
`protocol`	IDSEventProtocol!	IP protocols to match.
`srcPortRange`	PortRange!	Source port range to match traffic from.
`srcPrefix`	IPPrefix!	Source IP prefix to match traffic from.
`vlanBindings`	[VLAN!]	VLANs bound to this rule.

IDSEventLocation

Location of IDS event based on IP lookup

Field	Type	Description
`countryCode`	String!	ISO-3166 alpha-2 country code
`latitude`	Float!	Latitude of location
`longitude`	Float!	Longitude of location

IDSEventTLSInfo

https://docs.suricata.io/en/latest/output/eve/eve-json-format.html#event-type-tls

Field	Type	Description
`ja3Hash`	String!	The JA3 hash.
`ja3sHash`	String!	The JA3S hash.
`sni`	String!	The Server Name Indication (SNI) extension sent by the client

IDSEventsPage

A paged response for IDS event queries.

Field	Type	Description
`events`	[IDSEvent!]	A subset of records based on the limit and offset fields.
`total`	Int!	The total number of records.

IDSIPSCategory

A category for IDS/IPS rules.

Field	Type	Description
`UUID`	UUID!	Unique identifier for this category.
`createdAt`	DateTime!	When this category was created.
`priority`	Int!	The priority of this category.
`ruleCount`	Int!	The number of rules associated with this category.
`shortDescription`	String!	A short description of this category.
`shortname`	String!	The unique shortname code for this category.
`updatedAt`	DateTime!	When this category was updated.

IDSIPSConfig

Holds the IDS IPS config for a network.

Field	Type	Description
`UUID`	UUID!	Unique identifier for this configuration.
`boundCategories`	[IDSIPSConfigCategoryBinding!]!	The configured categories for this config.
`boundIDSRules`	[IDSIPSConfigRuleBinding!]!	The explicitly configured rules for this config.
`createdAt`	DateTime!	When this configuration was created.
`customRules`	[IDSIPSCustomRule!]	The custom rules for this config.
`enabledVLANs`	[VLAN!]!	The VLANs this is enabled for.
`ipsRuleDuration`	Duration	Validity of ips generated rules.
`isEastWestProtectionEnabled`	Boolean!	If east-west protection is enabled.
`minIPSSeverity`	Int	The IPS minimum severity to act on.
`minSeverity`	Int!	The IDS minimum severity to act on.
`mode`	IDSIPSMode!	The mode IDS/IPS should act in.
`networkUUID`	UUID!	The UUID of the network for this configuration.
`safelist`	[IPPrefix!]	List of subnets that should never be blocked.
`suppressedCategories`	[IDSIPSConfigCategorySuppression!]!	The suppressed (allowed) categories for this config.
`suppressedRules`	[IDSIPSConfigRuleSuppression!]!	The suppressed (allowed) rules for this config.

IDSIPSConfigCategoryBinding

A category for IDS/IPS rules.

Field	Type	Description
`category`	IDSIPSCategory!	The bound IDS/IPS category.
`categoryUUID`	UUID!	Unique identifier for the bound IDS/IPS category.
`config`	IDSIPSConfig!	The bound IDS/IPS configuration.
`configUUID`	UUID!	Unique identifier for the bound IDS/IPS configuration.
`createdAt`	DateTime	When this category was created. Will be null if the binding is an implicit default.
`mode`	IDSIPSMode!	The mode of this binding, whether it applies to IDS or IPS.
`updatedAt`	DateTime	When this category was updated. Will be null if the binding is an implicit default.

IDSIPSConfigCategorySuppression

A suppressed category for an IDS/IPS config.

Field	Type	Description
`UUID`	UUID!	Unique identifier of the IDS/IPS config suppressed category.
`category`	IDSIPSCategory!	The IDS category.
`categoryUUID`	UUID!	Unique identifier of the category.
`configUUID`	UUID!	Unique identifier of the IDS/IPS configuration.
`description`	String	An optional informational description for the suppression.
`direction`	IDSIPSSuppressedRuleDirection	The traffic direction to consider when determining IP prefix application. Required if `ipPrefixes` is set.
`ipPrefixes`	[IPPrefix!]	The IP prefixes that this suppression should apply to. If set, `direction` is required.
`mode`	IDSIPSMode!	The mode of this suppression, whether it applies to IDS or IPS.

IDSIPSConfigRuleBinding

A configured IDS rule for an IDS/IPS config.

Field	Type	Description
`configUUID`	UUID!	Unique identifier of the IDS/IPS configuration.
`mode`	IDSIPSMode!	The mode of this binding, whether it applies to IDS or IPS.
`rule`	IDSRule!	The IDS rule.
`ruleSID`	Int!	Unique signature ID of the IDS rule.

IDSIPSConfigRuleSuppression

A suppressed IDS rule for an IDS/IPS config.

Field	Type	Description
`UUID`	UUID!	Unique identifier of the IDS/IPS config suppressed rule.
`configUUID`	UUID!	Unique identifier of the IDS/IPS configuration.
`description`	String	An optional informational description for the suppression.
`direction`	IDSIPSSuppressedRuleDirection	The traffic direction to consider when determining IP prefix application. Required if `ipPrefixes` is set.
`ipPrefixes`	[IPPrefix!]	The IP prefixes that this suppression should apply to. If set, `direction` is required.
`mode`	IDSIPSMode!	The mode of this suppression, whether it applies to IDS or IPS.
`rule`	IDSRule!	The IDS rule.
`ruleSID`	Int!	Unique signature ID of the IDS rule.

IDSIPSCustomRule

A custom intrusion rule definition for IDS/IPS. These currently apply tls.sni rules.

Field	Type	Description
`UUID`	UUID!	Unique identifier.
`action`	FirewallRuleAction!	The action this rule applies.
`application`	ApplicationDNSFirewallRuleApplication	The application this rule applies to.
`boundVLANs`	[VLAN!]	List of VLAN bindings for the rule.
`configUUID`	UUID!	Unique identifier of the IDS/IPS configuration.
`createdAt`	DateTime!	When this rule was created.
`domain`	String	The FQDN this rule applies to.
`isEnabled`	Boolean!	If this rule is enabled.
`name`	String!	A name to identify this rule.
`updatedAt`	DateTime!	When this rule was updated.

IDSRule

A single available intrusion rule definition for IDS/IPS.

Field	Type	Description
`SID`	Int!	The unique signature ID for this rule.
`UUID`	UUID!	Unique identifier for this rule.
`action`	String!	The action for this rule.
`category`	IDSIPSCategory	The associated category for this rule, if present.
`classType`	String!	The category class type (shortname) for this rule.
`createdAt`	DateTime!	When this rule was created.
`description`	String	The description for this rule.
`groupID`	Int	The group ID for this rule.
`header`	String!	The header for this rule.
`metadata`	[String!]!	The list of metadata entries for this rule.
`references`	[IDSRuleReference!]!	The list of references for this rule.
`revision`	Int!	The revision version for this rule.
`updatedAt`	DateTime!	When this rule was updated.

IDSRuleReference

A key/value reference entry for an IDS rule.

Field	Type	Description
`ref`	String!	The value of the reference.
`type`	String!	The type of the reference.

InterVLANCommunicationPermittedPair

A pair of VLANs that are permitted to communicate with each other.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the inter-VLAN communication pair.
`higherVLAN`	VLAN!	The other VLAN in the permitted communication pair.
`lowerVLAN`	VLAN!	One VLAN in the permitted communication pair.
`networkUUID`	UUID!	The UUID of the network to which the VLANs belong.

MailingAddress

Represents a mailing address with optional coordinates and timezone.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the mailing address.
`city`	String	The city of the mailing address.
`coordinates`	Coordinates	The geographical coordinates of the mailing address.
`countryISO2`	String	The two-letter ISO code of the country.
`line1`	String	The first line of the mailing address.
`line2`	String	The second line of the mailing address.
`postalCode`	String	The postal code or ZIP code of the mailing address.
`subdivisionCode`	String	The subdivision code, such as the state or province code.
`timezone`	String!	The timezone associated with the mailing address.

MetricsMetadata

Metadata providing the minimum and maximum values among all metrics data points.

Field	Type	Description
`maxValue`	Float!	The maximum value among all metrics data points.
`minValue`	Float!	The minimum value among all metrics data points.

Network

A network is a grouping of devices in a single location belonging to a company. A core Meter entity.

Field	Type	Description
`UUID`	UUID!	The unique identifier of the network.
`company`	Company	The company that this network belongs to.
`companySlug`	String	The slug identifier of the company that this network belongs to.
`createdAt`	DateTime!	The date and time when the network was created.
`deletedAt`	DateTime	The date and time when the network was deleted, if applicable.
`floorPlans`	[FloorPlan!]!	The floor plans associated with the network.
`goLiveAt`	DateTime	The date the network first started serving traffic.
`idsIPSConfig`	IDSIPSConfig	IDS IPS config associated with the network.
`isActive`	Boolean!	Whether or not the network is currently serving traffic.
`label`	String!	A short code to quickly identify the network. Useful for customers with many networks and a need to quickly identify them.
`mailingAddress`	MailingAddress	The mailing address associated with the network.
`onboarding`	NetworkOnboarding	Somewhat legacy onboarding information from Airtable job. Different from `onboardingDocument`.
`onboardingDocument`	NetworkOnboardingDocument	Onboarding document form completed prior to network going live. Different from `onboarding`.
`radioProfiles`	[RadioProfile!]!	The radio profiles associated with the network.
`slug`	String!	A human-readable identifier for the network. Used in URLs to identify the network.
`ssids`	[SSID!]!	The SSIDs associated with the network.
`updatedAt`	DateTime!	The date and time when the network was last updated.
`virtualDevices`	[VirtualDevice!]!	The virtual devices associated with the network, optionally filtered.
`vlans`	[VLAN!]!	The VLANs associated with the network.

NetworkClient

A network client is a large container for all of the data that constitutes a client connected to a network.

Field	Type	Description
`accessPoint`	AccessPointVirtualDevice	The access point to which the client is connected, if applicable.
`alias`	String	A user-defined MACAddressAlias for the client if one is defined for the company.
`channel`	Int	The channel number used by the client's wireless connection.
`channelWidth`	Int	The channel width used by the client's wireless connection.
`clientName`	String	The friendly name of the client device, if available from DHCP.
`connectedSSID`	SSID	The SSID to which the client is connected, if wireless.
`connectedVLAN`	VLAN	The VLAN to which the client is connected.
`deviceVendor`	String	The vendor of the client device (often its manufacturer), if known. Derived from the IEEE OUI database.
`hwMode`	NetworkClientHWMode	Hardware mode of the device a client is connected to.
`ip`	String!	The IP address assigned to the client.
`isWireless`	Boolean!	If false, the client is connected via a wired connection.
`lastSeen`	DateTime!	The timestamp when the client was last seen on the network.
`latencyNs`	Int	The latency between the controller and the client, measured in nanoseconds.
`macAddress`	MacAddress!	The MAC address of the client.
`networkUUID`	UUID!	The UUID of the network to which this client is connected.
`noise`	Int	The noise level of the client's connection, measured in dBm.
`numSpatialStreams`	Int	The total number of spatial streams a client device can support, determined as the minimum of its transmit (TX) and receive (RX) spatial streams.
`phyInterfacesConnectedToRecently`	[PhyInterface!]!	The physical switch port(s) this wired client has recently been connected to. May return multiple results if the client changed ports recently.
`radioBand`	RadioBand	If the client is wireless, the radio band it is connected on.
`rxRate`	Int	The receive rate of the client connection, in bits per second.
`signal`	Int	The signal strength of the client's connection, measured in dBm.
`signalToNoiseRatio`	Int	The signal-to-noise ratio of the client's connection, measured in dB. Literally `signal - noise`. Null if either `signal` or `noise` is null.
`throughput`	NetworkClientThroughput	The average network throughput of the client during the lookback period.
`totalRxBytes`	Int	The total number of bytes received by the client over the requested lookback period.
`totalTxBytes`	Int	The total number of bytes transmitted by the client over the requested lookback period.
`txRate`	Int	The transmit rate of the client connection, in bits per second.
`vlanUUID`	UUID	The UUID of the VLAN to which the client is connected. Only supported for Config 2 networks.
`wirelessScore`	Float	Wireless score computed based on the current health of the client.

NetworkClientBlocklistEntry

Entries representing MAC addresses blocked on a given network.

Field	Type	Description
`createdAt`	DateTime	Timestamp this entry was created.
`macAddress`	MacAddress	The MAC address being blocked.
`network`	Network!	The network that the MAC address is blocked on.
`networkUUID`	UUID!	Unique identifier for the network that the MAC address is blocked on.
`oui`	String	The OUI being blocked. Only one of either MAC Address or OUI is set.
`ssid`	SSID	The SSID this blocklist entry is scoped to, if any.
`ssidUUID`	UUID	If set, the SSID this blocklist entry is scoped to. If null, the entry is network-wide.
`uuid`	UUID	Primary key.

NetworkClientThroughput

Represents the throughput of a client device.

Field	Type	Description
`rxRate`	Float	The average receive rate of the client, in bits per second.
`txRate`	Float	The average transmit rate of the client, in bits per second.

NetworkOnboarding

Represents the onboarding process for a network.

Field	Type	Description
`UUID`	UUID!	Unique identifier for the network onboarding entry.
`createdAt`	DateTime!	Timestamp when the network onboarding was created.
`jobData`	NetworkOnboardingJobData	Job data associated with the network onboarding.
`jobDataID`	String!	Identifier of the associated job data.
`networkUUID`	UUID!	Unique identifier of the associated network.
`updatedAt`	DateTime!	Timestamp when the network onboarding was last updated.

NetworkOnboardingDocument

Document containing information required for network onboarding.

Field	Type	Description
`UUID`	UUID!	Unique identifier for the network onboarding document.
`createdAt`	DateTime!	Timestamp when the document was created.
`delegations`	[NetworkOnboardingFieldDelegation!]!	List of fields that have been delegated to other users for completion.
`document`	JSONObject!	JSON object containing the onboarding document data.
`documentEditors`	[NetworkOnboardingDocumentFieldEditor!]!	List of editors for each field in the document.
`documentMetadata`	JSONObject	JSON object containing the onboarding document metadata data.
`documentMetadataEditors`	[NetworkOnboardingDocumentFieldEditor!]!	List of editors for each field in the document metadata.
`networkUUID`	UUID!	Unique identifier of the associated network.
`updatedAt`	DateTime!	Timestamp when the document was last updated.

NetworkOnboardingDocumentFieldEditor

Information about the edit history for a specific field of the network onboarding document.

Field	Type	Description
`fieldName`	String!	Name of the field that was edited.
`history`	[NetworkOnboardingDocumentFieldEditorHistoryEntry!]!	History of edits for this field, ordered from oldest to newest.

NetworkOnboardingDocumentFieldEditorHistoryEntry

A single edit entry in the history of a field.

Field	Type	Description
`updatedAt`	DateTime!	Timestamp when the field was edited.
`username`	String!	Name of the user who edited the field.

NetworkOnboardingFieldDelegation

Represents the delegation of a specific field of the network onboarding document to a user.

Field	Type	Description
`UUID`	UUID!	Unique identifier of the field delegation.
`description`	String	Description of the delegation.
`email`	String!	Email of the user to whom the field is delegated.
`fieldName`	String!	Name of the field being delegated.
`networkUUID`	UUID!	Unique identifier of the associated network.

NetworkOnboardingJobData

Stores logistical data for tracking the installation and onboarding of a network.

Field	Type	Description
`fullAddress`	[String!]	Full address of the network location, possibly including address lines, city, state, and ZIP code.
`id`	String!	Unique identifier of the job data.
`jobID`	String	Identifier of the job.
`jobOwnerUser`	String	User who owns the job.
`jobStatus`	String	Current status of the job.
`jobTechnicianPhone`	[String!]	Phone numbers of the technicians assigned to the job.
`locationCode`	String	Code identifying the location.
`targetGoLiveDate`	DateTime	Target date for the network to go live.
`totalSqFt`	[String!]	Total square footage of the network location.

NetworkThreatObserver

Represents an observer of a network threat. Will usually be an access point.

Field	Type	Description
`noiseFloor`	Int!	The noise floor represents the background signal interference by the observer, which can affect the clarity and accuracy of the signal measurement from the network threat.
`observedAt`	DateTime!	The time that the observation occurred.
`rssi`	Int!	The RSSI represents the signal strength measured by the observer from the network threat.
`ssid`	String!	The SSID that this observer is seeing the threat broadcast.
`virtualDevice`	VirtualDevice	The virtual device that observed the network threat.
`virtualDeviceUUID`	UUID!	The UUID of the virtual device that observed the network threat.

NetworkUplinkQualityResponse

The response containing quality metrics for a network uplink.

Field	Type	Description
`metadata`	MetricsMetadata	Metadata about the metrics.
`values`	[NetworkUplinkQualityValue!]!	A list of quality metric values.

NetworkUplinkQualityValue

Represents the quality metrics value for a network uplink.

Field	Type	Description
`networkUUID`	UUID!	The UUID of the network associated with this quality metric. Note: Since there are many data points, we reference the entity by UUID instead of embedding it.
`phyInterfaceUUID`	UUID!	The UUID of the physical interface associated with this quality metric. Note: Since there are many data points, we reference the entity by UUID instead of embedding it.
`timestamp`	DateTime!	The timestamp when the metric was recorded.
`value`	Float!	The quality value measured at the given timestamp, typically represented as a percentage of successful pings.

NetworkUplinkThroughputMetricsResponse

The response containing throughput metrics for a network uplink.

Field	Type	Description
`metadata`	MetricsMetadata	Metadata about the metrics, such as time range and aggregation interval.
`values`	[NetworkUplinkThroughputMetricsValue!]!	A list of throughput metric values.

NetworkUplinkThroughputMetricsValue

Represents the throughput metrics value for a network uplink.

Field	Type	Description
`direction`	TrafficDirection!	Indicates the direction of the traffic.
`networkUUID`	UUID!	The UUID of the network associated with this throughput metric. Note: Since there are many data points, we reference the entity by UUID instead of embedding it.
`phyInterfaceUUID`	UUID!	The UUID of the physical interface associated with this throughput metric. Note: Since there are many data points, we reference the entity by UUID instead of embedding it.
`timestamp`	DateTime!	The timestamp when the metric was recorded.
`value`	Float!	The throughput value measured at the given timestamp, in bits per second.

OutletInterface

Specifies settings for a power outlet on a Power Distribution Unit (PDU).

Field	Type	Description
`UUID`	UUID!	Globally unique identifier for the outlet interface.
`createdAt`	DateTime!	Timestamp when the outlet interface was created.
`currentAmps`	Float	The current being drawn from the outlet in Amperes.
`description`	String	Description of the outlet interface.
`isEnabled`	Boolean!	Whether or not the interface is enabled.
`label`	String	User-defined label for the outlet interface.
`outletNumber`	Int!	Number identifying the outlet on the PDU.
`powerWatts`	Float	The power being drawn from the outlet in Watts.
`updatedAt`	DateTime!	Timestamp when the outlet interface was last updated.
`virtualDevice`	VirtualDevice	The virtual device associated with this outlet interface.
`virtualDeviceUUID`	UUID!	UUID of the virtual device associated with this outlet interface.

PDUMetricsTimeseriesResponse

Response type containing PDU timeseries data over a specified time range.

Field	Type	Description
`outlets`	[PDUOutletMetricsTimeseriesResponse!]!	Outlets metrics data from the PDU.
`temperatureCelsius`	BaseMetricsResponse!	Temperature readings from the PDU in celsius.
`virtualDevice`	`PowerDistributionUnitVirtualDevice!`	The PDU virtual device.
`virtualDeviceUUID`	UUID!	The unique identifier for the PDU virtual device.

PDUOutletMetricsTimeseriesResponse

Response type containing PDU outlet timeseries data over a specified time range.

Field	Type	Description
`currentAmps`	BaseMetricsResponse!	Average current in amps.
`frequencyHz`	BaseMetricsResponse!	Average frequency in hertz.
`outlet`	OutletInterface!	The outlet interface for this series.
`powerWatts`	BaseMetricsResponse!	Average power consumption in watts.
`voltageVolts`	BaseMetricsResponse!	Average voltage in volts.

PhyInterface

A PhyInterface is a physical interface on a device. It's a software representation of a physical port.

Field	Type	Description
`UUID`	UUID!	The unique identifier for the physical interface.
`allowedVLANs`	[VLAN!]	The allowed (tagged) VLANs that are permitted to have traffic on this interface.
`connectedDevices`	[PhyInterfaceConnectedDevice!]	Devices connected to this physical interface. If `isConnected` is true, this will only return devices that are actively connected, else it returns the most recent devices that were connected to the port in a longer lookback period.
`description`	String	A description of the physical interface.
`isBoundToAllVLANs`	Boolean!	Whether or not the interface is implicitly bound to all VLANs, including any future VLANs that are created. If set to true, all VLAN bindings (excluding the native VLAN) will be tagged on this interface.
`isConnected`	Boolean!	True if something is connected to the port.
`isEnabled`	Boolean!	Whether or not the interface is enabled. Interfaces that are not enabled are still visible to the user.
`isEthernet`	Boolean!	Indicates if the port is an Ethernet port.
`isPOEEnabled`	Boolean!	Whether or not the interface is enabled to deliver Power over Ethernet.
`isSFP`	Boolean!	Indicates if the port is an SFP port.
`isSTPEnabled`	Boolean!	Whether or not the interface is enabled to participate in Spanning Tree Protocol.
`isSTPForwarding`	Boolean	Indicates if the port is forwarding (true) or blocking (false) due to STP.
`isTrunkPort`	Boolean!	A trunk port is a port that is assigned to carry traffic for multiple VLANs.
`isUplink`	Boolean!	An uplink interface connects the device to other networks or network devices.
`isUplinkActive`	Boolean	Only populated if `isUplink` is true. Indicates if this uplink physical interface is currently active.
`label`	String	A custom label for the physical interface.
`nativeVLAN`	VLAN	The native (untagged) VLAN that is assigned to this interface.
`portNumber`	Int!	The physical port number on the device where the interface is located.
`portSpeedMbps`	Int	The link speed on the port, populated from our time series database.
`switchPortStats`	[SwitchPortStat!]	For phy interfaces belonging to a switch, aggregated statistics over a specified lookback period.
`uplinkPriority`	Int	Can only be populated if `isUplink` is true. The priority order in which the uplink should be used.
`virtualDeviceUUID`	UUID!	The UUID of the virtual device that this physical interface belongs to.

PhyInterfaceConnectedDevice

Represents a device connected to a physical interface.

Field	Type	Description
`client`	NetworkClient	Network client for the connected device, if available.
`hardwareDevice`	HardwareDevice	If the macAddress belongs to a hardware device, this field will load it from the database.
`networkUUID`	UUID!	The network UUID.
`phyInterface`	PhyInterface	The other phy interface that is plugged into the calling phy interface, if the other device is a Meter device.
`portNumber`	Int	The port number of the other phy interface that is plugged into the calling phy interface, if the other device is a Meter device.

PoEInfo

Contains info about the PoE (Power over Ethernet) usage of a hardware device.

Field	Type	Description
`max`	Float	The maximum PoE power supplyable by the device (in Watts).
`used`	Float	The current PoE power usage value (in Watts).
`usedCreatedAt`	DateTime	The timestamp when the current PoE power usage was recorded.

PortRange

Represents a range of ports.

Field	Type	Description
`lower`	Int!	Lower bound of the port range.
`upper`	Int!	Upper bound of the port range.

RadioProfile

Contains configuration for wireless radios. A profile is a way to apply the same configuration to multiple APs.

Field	Type	Description
`UUID`	UUID!	The unique identifier for the radio profile.
`band2_4GAllowedChannels`	[Int!]	Only set if band2_4GAutoChannelIsEnabled is true. This is the list of channels that are permitted for ACS (auto channel selection) to select from and is user-configurable.
`band2_4GAutoChannelIsEnabled`	Boolean!	Indicates whether auto channel selection is enabled for the 2.4 GHz band.
`band2_4GAutoChannelWidthIsEnabled`	Boolean!	Indicates whether auto channel width selection is enabled for the 2.4 GHz band.
`band2_4GAutoTxPowerIsEnabled`	Boolean!	Indicates whether automatic transmit power adjustment is enabled for the 2.4 GHz band.
`band2_4GAutoTxPowerMaxdBm`	Int	Only set if band2_4GAutoTxPowerIsEnabled is true. The maximum transmit power in dBm for the 2.4 GHz band when auto transmit power is enabled.
`band2_4GAutoTxPowerMindBm`	Int	Only set if band2_4GAutoTxPowerIsEnabled is true. The minimum transmit power in dBm for the 2.4 GHz band when auto transmit power is enabled.
`band2_4GChannelWidthMHz`	Int	Only set if band2_4GAutoChannelWidthIsEnabled is false. The channel width in MHz for the 2.4 GHz band when auto channel width is disabled.
`band2_4GIsEnabled`	Boolean!	Indicates whether the 2.4 GHz band is enabled.
`band5GAllowedChannels`	[Int!]	Only set if band5GAutoChannelIsEnabled is true. This is the list of channels that are permitted for ACS (auto channel selection) to select from and is user-configurable.
`band5GAutoChannelIsEnabled`	Boolean!	Indicates whether auto channel selection is enabled for the 5 GHz band.
`band5GAutoChannelWidthIsEnabled`	Boolean!	Indicates whether auto channel width selection is enabled for the 5 GHz band.
`band5GAutoTxPowerIsEnabled`	Boolean!	Indicates whether automatic transmit power adjustment is enabled for the 5 GHz band.
`band5GAutoTxPowerMaxdBm`	Int	Only set if band5GAutoTxPowerIsEnabled is true. The maximum transmit power in dBm for the 5 GHz band when auto transmit power is enabled.
`band5GAutoTxPowerMindBm`	Int	Only set if band5GAutoTxPowerIsEnabled is true. The minimum transmit power in dBm for the 5 GHz band when auto transmit power is enabled.
`band5GChannelWidthMHz`	Int	Only set if band5GAutoChannelWidthIsEnabled is false. The channel width in MHz for the 5 GHz band when auto channel width is disabled.
`band5GIsEnabled`	Boolean!	Indicates whether the 5 GHz band is enabled.
`band6GAllowedChannels`	[Int!]	Only set if band6GAutoChannelIsEnabled is true. This is the list of channels that are permitted for ACS (auto channel selection) to select from and is user-configurable.
`band6GAutoChannelIsEnabled`	Boolean!	Indicates whether auto channel selection is enabled for the 6 GHz band.
`band6GAutoChannelWidthIsEnabled`	Boolean!	Indicates whether auto channel width selection is enabled for the 6 GHz band.
`band6GAutoTxPowerIsEnabled`	Boolean!	Indicates whether automatic transmit power adjustment is enabled for the 6 GHz band.
`band6GAutoTxPowerMaxdBm`	Int	Only set if band6GAutoTxPowerIsEnabled is true. The maximum transmit power in dBm for the 6 GHz band when auto transmit power is enabled.
`band6GAutoTxPowerMindBm`	Int	Only set if band6GAutoTxPowerIsEnabled is true. The minimum transmit power in dBm for the 6 GHz band when auto transmit power is enabled.
`band6GChannelWidthMHz`	Int	Only set if band6GAutoChannelWidthIsEnabled is false. The channel width in MHz for the 6 GHz band when auto channel width is disabled.
`band6GIsEnabled`	Boolean!	Indicates whether the 6 GHz band is enabled.
`createdAt`	DateTime!	The timestamp when the radio profile was created.
`description`	String	A human-readable description.
`isDefault`	Boolean!	Indicates whether this profile is the default profile for the network.
`name`	String!	The name of the radio profile.
`networkUUID`	UUID!	The unique identifier of the network to which this radio profile belongs.
`regulatoryDomain`	String!	The ISO2 country code where the device is located.
`updatedAt`	DateTime!	The timestamp when the radio profile was last updated.
`virtualDevices`	[VirtualDevice!]!	The list of virtual devices (access points) attached to this radio profile.

RadioSettings

An individual Access Point's radio settings (channel, power). Other radio settings are configured in the radio profile and shared across multiple APs.

Field	Type	Description
`band2_4GActiveChannel`	Int	The active channel for the 2.4 GHz radio band. It can be used to determine if the AP is broadcasting on the primary, secondary, or other (DFS, etc). It comes from stats, and is not configurable.
`band2_4GPrimaryChannel`	Int!	The primary channel for the 2.4 GHz radio band.
`band2_4GTransmitPowerdBm`	Int!	The transmit power in dBm for the 2.4 GHz radio band.
`band5GActiveChannel`	Int	The active channel for the 5 GHz radio band. It can be used to determine if the AP is broadcasting on the primary, secondary, or other (DFS, etc). It comes from stats, and is not configurable.
`band5GPrimaryChannel`	Int!	The primary channel for the 5 GHz radio band.
`band5GSecondaryChannel`	Int	The secondary channel for the 5 GHz radio band, if applicable.
`band5GTransmitPowerdBm`	Int!	The transmit power in dBm for the 5 GHz radio band.
`band6GActiveChannel`	Int	The active channel for the 6 GHz radio band. It can be used to determine if the AP is broadcasting on the primary, secondary, or other (DFS, etc). It comes from stats, and is not configurable.
`band6GPrimaryChannel`	Int!	The primary channel for the 6 GHz radio band.
`band6GTransmitPowerdBm`	Int!	The transmit power in dBm for the 6 GHz radio band.
`virtualDeviceUUID`	UUID!	The UUID of the virtual device.

RogueAccessPoint

A rogue access point is when an unrecognized access point is plugged into one of Meter's switches.

Field	Type	Description
`macAddress`	MacAddress!	The mac address of the rogue AP.
`network`	Network!	The network that the rogue AP was observed on.
`networkUUID`	UUID!	The unique identifier for the network that the rogue AP was observed on.
`observers`	[NetworkThreatObserver!]!	The devices that were able to observe the rogue AP.
`phyInterface`	PhyInterface!	The physical interface that the rogue access point is plugged into.
`vendor`	String	The vendor that made the rogue AP.

SSID

Service set identifiers (SSIDs) for a network.

Field	Type	Description
`UUID`	UUID!	Unique identifier for the SSID.
`createdAt`	DateTime!	Timestamp when the SSID was created.
`encryptionProtocol`	SSIDEncryptionProtocol	Encryption protocol used by the SSID. If null, this is an open network.
`isBand2GAllowed`	Boolean!	Whether or not the SSID is allowed to be broadcasted on the 2.4 GHz radio.
`isBand5GAllowed`	Boolean!	Whether or not the SSID is allowed to be broadcasted on the 5 GHz radio.
`isBand6GAllowed`	Boolean!	Whether or not the SSID is allowed to be broadcasted on the 6 GHz radio.
`isEnabled`	Boolean!	Indicates whether the SSID is enabled.
`isGuest`	Boolean!	If true, the SSID is considered as guest and can be displayed on site for guest access, for example on a kiosk.
`isHidden`	Boolean!	Whether or not the broadcasted SSID is visible to clients; clients have to manually input the SSID to join the network.
`networkUUID`	UUID!	UUID of the network this SSID belongs to.
`primaryEncryption8021X`	Encryption8021X	Primary 802.1X encryption configuration for Enterprise authentication.
`secondaryEncryption8021X`	Encryption8021X	Secondary 802.1X encryption configuration for Enterprise authentication.
`ssid`	String!	Name of the SSID (network name).
`updatedAt`	DateTime!	Timestamp when the SSID was last updated.
`vlan`	VLAN	VLAN associated with the SSID. This field must be non-null if the SSID is enabled.

SwitchHardwareDevice

A switch hardware device represents a physical switch.

Field	Type	Description
`createdAt`	DateTime!	The timestamp when the hardware device was first created in the system.
`deviceModel`	DeviceModel!	The model name of the hardware device.
`deviceType`	DeviceType!	The type of the hardware device.
`disconnectedFromBackendAt`	DateTime	If the device is no longer connected to the backend, this is the time at which it was last connected.
`ipAddress`	String	The IP address of the switch hardware device.
`isConnectedToBackend`	Boolean!	Indicates whether the hardware device is connected to the backend.
`isSpare`	Boolean!	A spare hardware device belongs to a network but not a virtual device. Used most often to keep track of spare hardware we ship to a customer but don't install immediately.
`macAddress`	MacAddress	The MAC address of the hardware device.
`networkUUID`	UUID	The UUID of the network that the hardware device belongs to.
`serialNumber`	String!	The unique serial number of the hardware device.
`updatedAt`	DateTime!	The timestamp when the hardware device was last updated in the system.
`virtualDevice`	VirtualDevice	The virtual device associated with this hardware device, if any.
`virtualDeviceUUID`	UUID	The UUID of the virtual device this hardware device is assigned to, if any.

SwitchMACTableEntry

Represents an entry in the switch's MAC address table, mapping MAC addresses to ports and VLANs.

Field	Type	Description
`phyInterface`	PhyInterface!	The physical interface where the MAC address was observed.
`updatedAt`	DateTime!	The timestamp when the entry was last updated.
`virtualDeviceUUID`	UUID!	The UUID of the switch virtual device.
`vlan`	VLAN	The VLAN associated with the VLAN ID.
`vlanID`	Int!	The VLAN ID associated with the MAC address.

SwitchPortMetricsRateResponse

Response type containing an array of per-port rate metrics at specific timestamps.

Field	Type	Description
`values`	[SwitchPortMetricsRateValue!]!	An array of per-port metrics expressed as rates at specific timestamps.

SwitchPortMetricsRateValue

Per-port metrics data expressed as rates (per second) at specific timestamps.

Field	Type	Description
`broadcastRxPacketsPerSecond`	Float!	Total number of broadcast packets per second received in the given time period; a subset of totalRxPackets.
`broadcastTxPacketsPerSecond`	Float!	Total number of broadcast packets per second received in the given time period; a subset of totalRxPackets.
`dropsPerSecond`	Float!	The rate of packets per second that were dropped during transmission or reception on this port.
`multicastRxPacketsPerSecond`	Float!	Total number of multicast packets per second received in the given time period; a subset of totalRxPackets.
`multicastTxPacketsPerSecond`	Float!	Total number of multicast packets per second transmitted in the given time period; a subset of totalTxPackets.
`portNumber`	Int!	The physical port number on the switch.
`rxErrPerSecond`	Float!	The rate of reception errors per second on this port.
`timestamp`	DateTime!	The timestamp for when the rate values were calculated.
`totalRxBytesPerSecond`	Float!	The rate of bytes per second received on this port.
`totalTxBytesPerSecond`	Float!	The rate of bytes per second transmitted from this port.
`txErrPerSecond`	Float!	The rate of transmission errors per second on this port.

SwitchPortStat

Aggregated statistics per switch port over a specified lookback period.

Field	Type	Description
`broadcastRxPackets`	Int!	Total number of broadcast packets received on this port during the lookback period; a subset of totalRxPackets.
`broadcastTxPackets`	Int!	Total number of broadcast packets transmitted from this port during the lookback period; a subset of totalTxPackets.
`discardRxPackets`	Int!	Total number of packets received on this port but discarded due to errors or resource limitations during the lookback period; a subset of totalRxPackets.
`discardTxPackets`	Int!	Total number of packets attempted to be transmitted from this port but discarded due to errors or resource limitations during the lookback period; a subset of totalTxPackets.
`errorRxPackets`	Int!	Total number of packets received on this port that contained errors (e.g., CRC errors) during the lookback period; a subset of totalRxPackets.
`errorTxPackets`	Int!	Total number of packets transmitted from this port that encountered errors during the lookback period; a subset of totalTxPackets.
`multicastRxPackets`	Int!	Total number of multicast packets received on this port during the lookback period; a subset of totalRxPackets.
`multicastTxPackets`	Int!	Total number of multicast packets transmitted from this port during the lookback period; a subset of totalTxPackets.
`nonUnicastRxPackets`	Int!	Total number of non-unicast (i.e., multicast and broadcast) packets received on this port during the lookback period; a subset of totalRxPackets.
`nonUnicastTxPackets`	Int!	Total number of non-unicast (i.e., multicast and broadcast) packets transmitted from this port during the lookback period; a subset of totalTxPackets.
`portNumber`	Int!	The physical number of the port on the switch.
`totalRxBytes`	Int!	Total number of bytes received on this port during the lookback period.
`totalRxPackets`	Int!	Total number of packets received on this port during the lookback period.
`totalTxBytes`	Int!	Total number of bytes transmitted from this port during the lookback period.
`totalTxPackets`	Int!	Total number of packets transmitted from this port during the lookback period.
`unicastRxPackets`	Int!	Total number of unicast packets received on this port during the lookback period; a subset of totalRxPackets.
`unicastTxPackets`	Int!	Total number of unicast packets transmitted from this port during the lookback period; a subset of totalTxPackets.

SwitchVirtualDevice

A switch virtual device is a logical representation of a physical switch.

Field	Type	Description
`UUID`	UUID!	The unique identifier (UUID) of the virtual device.
`createdAt`	DateTime!	The timestamp when the virtual device was first created in the system.
`description`	String	An optional description for the virtual device.
`deviceModel`	DeviceModel!	The model name of the virtual device.
`deviceType`	VirtualDeviceType!	The type of the virtual device.
`hardwareDevice`	HardwareDevice	The hardware device associated with this virtual device, if any.
`isOnline`	Boolean!	Indicates whether the hardware device is online, indicated by its heartbeat.
`label`	String!	A human-friendly name for the device.
`macTable`	[SwitchMACTableEntry!]	The MAC table of the switch (ie. the ports and the MAC addresses of the devices connected to them).
`networkUUID`	UUID!	The unique identifier (UUID) of the network the virtual device belongs to.
`phyInterfaces`	[PhyInterface!]!	The physical interfaces associated with the switch.
`poeInfo`	PoEInfo	Information about the switch's Power over Ethernet (PoE) usage.
`updatedAt`	DateTime!	The timestamp when the virtual device was last updated in the system.
`uptime`	Duration	The uptime from our time series database for the device.

ThroughputValueWithDirection

Represents a throughput data point with its value and traffic direction.

Field	Type	Description
`direction`	TrafficDirection!	The direction of traffic for the throughput value.
`value`	Int!	The throughput value in bits per second.

User

A user is a person or machine that has access to Meter.

Field	Type	Description
`email`	String!	The email address of the user.
`firstName`	String	The first name of the user.
`lastName`	String	The last name of the user.
`profilePictureUrl`	String	URL of user profile picture.

VLAN

A VLAN (virtual LAN) is a logical network segment that allows network devices to communicate as if they were physically connected to the same network.

Field	Type	Description
`UUID`	UUID!	The unique identifier for the VLAN.
`description`	String	An optional description of the VLAN.
`dhcpRule`	DHCPRule	The DHCP rule associated with this VLAN.
`ipV4ClientAssignmentProtocol`	ClientAssignmentProtocol	Specifies the protocol for assigning IPv4 addresses to clients on this VLAN.
`ipV4ClientGateway`	IPV4	Specifies the IPv4 gateway address for this VLAN. This value should not include a netmask.
`ipV4ClientPrefixLength`	Int	Specifies the IPv4 prefix length (subnet mask) for this VLAN.
`ipV6ClientAssignmentProtocol`	ClientAssignmentProtocol	Specifies the protocol for assigning IPv6 addresses to clients on this VLAN.
`ipV6ClientGateway`	IPV6	Specifies the IPv6 gateway address for this VLAN. This value should not include a netmask.
`ipV6ClientPrefixLength`	Int	Specifies the IPv6 prefix length (subnet mask) for this VLAN.
`isDefault`	Boolean!	Only one VLAN per network can be the default VLAN. Untagged packets that don't belong to any configured VLANs are assigned to the default one.
`isEnabled`	Boolean!	If true, the VLAN is enabled and can be used in the network.
`name`	String!	A human-friendly name to identify the VLAN, like "guest". Unique per network.
`networkUUID`	UUID!	The UUID of the network to which the VLAN belongs.
`vlanID`	Int!	The VLAN ID. Must be between 1 and 4094 and is unique per network.

VirtualDevice

A virtual device is a logical representation of a physical device; configuration is associated with the virtual device.

Field	Type	Description
`UUID`	UUID!	The unique identifier (UUID) of the virtual device.
`createdAt`	DateTime!	The timestamp when the virtual device was first created in the system.
`description`	String	An optional description for the virtual device.
`deviceModel`	DeviceModel!	The model name of the virtual device.
`deviceType`	VirtualDeviceType!	The type of the virtual device.
`hardwareDevice`	HardwareDevice	The hardware device associated with this virtual device, if any.
`isOnline`	Boolean!	Indicates whether the hardware device is online, indicated by its heartbeat.
`label`	String!	A human-friendly name for the device.
`networkUUID`	UUID!	The unique identifier (UUID) of the network the virtual device belongs to.
`updatedAt`	DateTime!	The timestamp when the virtual device was last updated in the system.
`uptime`	Duration	The uptime from our time series database for the device.

VirtualDeviceTag

A virtual device tag is an attribute that can be applied to many virtual devices to group them together for bulk-actions and UI filtering.

Field	Type	Description
`UUID`	UUID!	Unique identifier of the virtual device tag.
`name`	String!	Name of the virtual device tag.
`networkUUID`	UUID!	Unique identifier of the network this tag belongs to.

WirelessClient

A single snapshot of client connectivity metrics for a single client. Not an average over a time period or across multiple clients.

Field	Type	Description
`associatedAt`	DateTime	When the client associated with the AP.
`band`	RadioBand!	The radio band the client is connected to.
`channel`	Int!	The channel number the client is using.
`channelWidth`	Int	The channel width the client is using.
`macAddress`	MacAddress!	The MAC address of the client device.
`metrics`	ClientMetricsTimeseriesValue!	The latest connectivity metrics of the client.
`networkUUID`	UUID!	The UUID of the network the client is connected to.
`ssid`	SSID!	The SSID that the client interacted with.
`ssidName`	String!	The name of the SSID that the client interacted with.
`virtualDevice`	AccessPointVirtualDevice!	The AP virtual device that the client interacted with.
`virtualDeviceUUID`	UUID!	The UUID of the AP virtual device the client is connected to.

WirelessClientMetricsResponse

Response type that contains ClientMetricsTimeseriesResponse for a single MAC address.

Field	Type	Description
`response`	ClientMetricsTimeseriesResponse!	The metrics for this MAC Address.

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

Was this helpful?

PreviousScalars NextConfiguring Slack Integration