Interface INetworksClientsBandwidthUsageHistory

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

public interface INetworksClientsBandwidthUsageHistory

Methods

GetNetworkClientsBandwidthUsageHistoryAsync(string, int?, string, string, string, string, double?, CancellationToken)

Returns a timeseries of total traffic consumption rates for all clients on a network within a given timespan, in megabits per second.

[Get("/networks/{networkId}/clients/bandwidthUsageHistory")]
Task<List<NetworkClientBandwidthUsageHistory>> GetNetworkClientsBandwidthUsageHistoryAsync(string networkId, int? perPage = 1000, string startingAfter = null, string endingBefore = null, string t0 = null, string t1 = null, double? timespan = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network 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.

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.

cancellationToken CancellationToken

Returns

Task<List<NetworkClientBandwidthUsageHistory>>

Exceptions

ApiException

Thrown when fails to make API call