Interface IWirelessChannelUtilizationHistory

Namespace

Meraki.Api.Interfaces.Products.Wireless

Assembly

Meraki.Api.dll

public interface IWirelessChannelUtilizationHistory

Methods

GetNetworkWirelessChannelUtilizationHistoryAsync(string, string, string, double?, int?, bool?, string?, string?, string?, string?, CancellationToken)

Return AP channel utilization over time for a device or network client

[Get("/networks/{networkId}/wireless/channelUtilizationHistory")]
Task<List<ChannelUtilizationHistory>> GetNetworkWirelessChannelUtilizationHistoryAsync(string networkId, string t0 = null, string t1 = null, double? timespan = null, int? resolution = null, bool? autoResolution = null, string? clientId = null, string? deviceSerial = null, string? apTag = null, string? band = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

t0 string

The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)

t1 string

The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)

timespan double?

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)

resolution int?

The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600.

autoResolution bool?

Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.

clientId string

Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history.

deviceSerial string

Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified.

apTag string

Filter results by AP tag to return AP channel utilization metrics for devices labeled with the given tag; either :clientId or :deviceSerial must be jointly specified.

band string

Filter results by band (either '2.4' or '5').

cancellationToken CancellationToken

Returns

Task<List<ChannelUtilizationHistory>>

Exceptions

ApiException

Thrown when fails to make API call