Interface IOrganizationBandwidthUsageHistory

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizationBandwidthUsageHistory

Methods

GetOrganizationClientsBandwidthUsageHistoryAsync(string, string, string, int, string?, string?, string?, string?, string?, CancellationToken)

Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.

[Get("/organizations/{organizationId}/clients/bandwidthUsageHistory")]
Task<List<BandwidthUsageHistory>> GetOrganizationClientsBandwidthUsageHistoryAsync(string organizationId, string t0, string t1, int timespan = 1, string? networkTag = null, string? deviceTag = null, string? networkId = null, string? ssidName = null, string? usageUplink = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

t0 string

The beginning of the timespan for the data.

t1 string

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

timespan int

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.

networkTag string

Match result to an exact network tag

deviceTag string

Match result to an exact device tag

networkId string

Match result to an exact network id

ssidName string

Filter results by ssid name

usageUplink string

Filter results by usage uplink

cancellationToken CancellationToken

Returns

Task<List<BandwidthUsageHistory>>

Exceptions

ApiException

Thrown when fails to make API call