Interface IWirelessClientsConnectivityEvents

Namespace

Meraki.Api.Interfaces.Products.Wireless

Assembly

Meraki.Api.dll

public interface IWirelessClientsConnectivityEvents

Methods

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

List the wireless connectivity events for a client within a network in the timespan.

[Get("/networks/{networkId}/wireless/clients/{clientId}/connectivityEvents")]
Task<List<ConnectivityEvents>> GetNetworkWirelessClientConnectivityEventsAsync(string networkId, string clientId, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, string? sortOrder = null, string? t0 = null, string? t1 = null, double? timespan = null, List<string>? types = null, List<string>? includedSeverities = null, string? band = null, int? ssidNumber = null, string? deviceSerial = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

clientId string

The client id

perPage int?

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

startingAfter string

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

endingBefore string

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

sortOrder string

Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'ascending'.

t0 string

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

t1 string

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

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.

types List<string>

A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'.

includedSeverities List<string>

A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'.

band string

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

ssidNumber int?

An SSID number to include. If not specified, events for all SSIDs will be returned.

deviceSerial string

Filter results by an AP's serial number.

cancellationToken CancellationToken

Returns

Task<List<ConnectivityEvents>>

Exceptions

ApiException

Thrown when fails to make API call