Interface IWirelessRadioRfHealth

Namespace

Meraki.Api.Interfaces.Products.Wireless

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IWirelessRadioRfHealth

Methods

GetOrganizationWirelessRadioRfHealthOverviewByNetworkByIntervalAsync(string, string?, string?, double?, int?, List<string>?, List<string>?, int?, int?, int?, int?, int?, int?, CancellationToken)

Return the RF health metrics, by network, for all bands over time

[Get("/organizations/{organizationId}/wireless/radio/rfHealth/overview/byNetwork/byInterval")]
Task<OrganizationWirelessRadioRfHealthOverviewByNetworkByInterval> GetOrganizationWirelessRadioRfHealthOverviewByNetworkByIntervalAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, int? interval = null, List<string>? networkIds = null, List<string>? bands = null, int? minimumRfHealthScore = null, int? maximumRfHealthScore = null, int? minimumHighCciPercentage = null, int? maximumHighCciPercentage = null, int? minimumChannelChanges = null, int? maximumChannelChanges = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

t0 string

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

t1 string

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

timespan double?

The timespan, in seconds, for which the information will be fetched. If specifying timespan, do not specify t0 and t1. Must be less than or equal to 2,629,746 seconds (confirmed by the API, which returns a 400 one second above this). The default is 14 days. (optional)

interval int?

The time interval in seconds for returned data. Valid values are 7200 and 86400 - any other value returns a 400 "invalid interval". Confirmed the API silently widens the default from 7200 to 86400 for large timespans when this is omitted, so pass it explicitly for a predictable bucket size. (optional)

networkIds List<string>

Optional parameter to filter results by network.

bands List<string>

Optional parameter to filter results by band. Valid bands are 2.4, 5 and 6.

minimumRfHealthScore int?

Optional parameter to filter results by minimum RF health score.

maximumRfHealthScore int?

Optional parameter to filter results by maximum RF health score.

minimumHighCciPercentage int?

Optional parameter to filter results by minimum high CCI percentage.

maximumHighCciPercentage int?

Optional parameter to filter results by maximum high CCI percentage.

minimumChannelChanges int?

Optional parameter to filter results by minimum channel changes.

maximumChannelChanges int?

Optional parameter to filter results by maximum channel changes.

cancellationToken CancellationToken

Returns

Task<OrganizationWirelessRadioRfHealthOverviewByNetworkByInterval>

Exceptions

ApiException

Thrown when fails to make API call