Interface IWirelessDevicePacketLoss

Namespace

Meraki.Api.Interfaces.Products.Wireless

Assembly

Meraki.Api.dll

Provides functionality to retrieve packet loss information for wireless devices within an organization.

public interface IWirelessDevicePacketLoss

Remarks

This interface defines a method for listing the most recent packet loss data for wireless devices. The data is paginated, and the caller can specify the number of entries per page.

Methods

GetOrganizationWirelessDevicesPacketLossAsync(string, IEnumerable<string>?, IEnumerable<string>?, IEnumerable<int>?, IEnumerable<string>?, int?, string?, string?, string?, string?, double?, CancellationToken)

List the most recent packet loss information for wireless devices.

[Get("/organizations/{organizationId}/wireless/devices/packetLoss/byDevice")]
Task<List<WirelessDevicePacketLoss>> GetOrganizationWirelessDevicesPacketLossAsync(string organizationId, IEnumerable<string>? networkIds = null, IEnumerable<string>? serials = null, IEnumerable<int>? ssids = null, IEnumerable<string>? bands = null, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, string? t0 = null, string? t1 = null, double? timespan = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization ID.

networkIds IEnumerable<string>

Filter results by network.

serials IEnumerable<string>

Filter results by device serial number.

ssids IEnumerable<int>

Filter results by SSID number.

bands IEnumerable<string>

Filter results by band. Valid bands are: 2.4, 5, and 6.

perPage int?

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

startingAfter string

A token used by the server to indicate the start of the page. This parameter should not be defined by client applications.

endingBefore string

A token used by the server to indicate the end of the page. This parameter should not be defined by client applications.

t0 string

The beginning of the timespan for the data. The maximum lookback period is 90 days from today.

t1 string

The end of the timespan for the data. t1 can be a maximum of 90 days after t0.

timespan double?

The timespan for which the information will be fetched, in seconds. If specifying timespan, do not specify parameters t0 and t1. Must be between 300 and 7776000 seconds.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<List<WirelessDevicePacketLoss>>

Exceptions

ApiException

Thrown when fails to make API call