Table of Contents

Interface IOrganizationsSummaryTop

Namespace
Meraki.Api.Interfaces.General.Organizations
Assembly
Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizationsSummaryTop

Methods

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

Return the top 10 appliances sorted by utilization over given time range.

[Get("/organizations/{organizationId}/summary/top/appliances/byUtilization")]
Task<List<ApplianceUtilizationSummary>> GetOrganizationSummaryTopAppliancesByUtilizationAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, string? networkTag = null, string? deviceTag = null, string? networkId = null, int? quantity = 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 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.

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

quantity int?

Set number of desired results to return. Default is 10.

ssidName string

Filter results by ssid name

usageUplink string

Filter results by usage uplink

cancellationToken CancellationToken

Returns

Task<List<ApplianceUtilizationSummary>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSummaryTopClientsByUsageAsync(string, string?, string?, double?, CancellationToken)

Return metrics for organization's top 10 clients by data usage (in mb) over given time range.

[Get("/organizations/{organizationId}/summary/top/clients/byUsage")]
Task<List<ClientUsageSummary>> GetOrganizationSummaryTopClientsByUsageAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = 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 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<ClientUsageSummary>>

Exceptions

ApiException

Thrown when fails to make API call

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

Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.

[Get("/organizations/{organizationId}/summary/top/clients/manufacturers/byUsage")]
Task<List<ClientManufacturersSummary>> GetOrganizationSummaryTopClientsManufacturersByUsageAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, string? networkTag = null, string? deviceTag = null, string? networkId = null, int? quantity = 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 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.

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

quantity int?

Set number of desired results to return. Default is 10.

ssidName string

Filter results by ssid name

usageUplink string

Filter results by usage uplink

cancellationToken CancellationToken

Returns

Task<List<ClientManufacturersSummary>>

Exceptions

ApiException

Thrown when fails to make API call

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

Return metrics for organization's top 10 devices sorted by data usage over given time range. Default unit is megabytes.

[Get("/organizations/{organizationId}/summary/top/devices/byUsage")]
Task<List<DeviceUsageSummary>> GetOrganizationSummaryTopDevicesByUsageAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, string? networkTag = null, string? deviceTag = null, string? networkId = null, int? quantity = 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 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.

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

quantity int?

Set number of desired results to return. Default is 10.

ssidName string

Filter results by ssid name

usageUplink string

Filter results by usage uplink

cancellationToken CancellationToken

Returns

Task<List<DeviceUsageSummary>>

Exceptions

ApiException

Thrown when fails to make API call

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

Return metrics for organization's top 10 device models sorted by data usage over given time range. Default unit is megabytes.

[Get("/organizations/{organizationId}/summary/top/devices/models/byUsage")]
Task<List<DeviceModelUsageSummary>> GetOrganizationSummaryTopDevicesModelsByUsageAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, string? networkTag = null, string? deviceTag = null, string? networkId = null, int? quantity = 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 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.

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

quantity int?

Set number of desired results to return. Default is 10.

ssidName string

Filter results by ssid name

usageUplink string

Filter results by usage uplink

cancellationToken CancellationToken

Returns

Task<List<DeviceModelUsageSummary>>

Exceptions

ApiException

Thrown when fails to make API call

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

Return metrics for organization's top 10 ssids by data usage over given time range. Default unit is megabytes.

[Get("/organizations/{organizationId}/summary/top/ssids/byUsage")]
Task<List<SsidUsageSummary>> GetOrganizationSummaryTopSsidsByUsageAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, string? networkTag = null, string? deviceTag = null, string? networkId = null, int? quantity = 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 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.

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

quantity int?

Set number of desired results to return. Default is 10.

ssidName string

Filter results by ssid name

usageUplink string

Filter results by usage uplink

cancellationToken CancellationToken

Returns

Task<List<SsidUsageSummary>>

Exceptions

ApiException

Thrown when fails to make API call

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

Return metrics for organization's top 10 switches by energy usage over given time range. Default unit is joules.

[Get("/organizations/{organizationId}/summary/top/switches/byEnergyUsage")]
Task<List<EnergyUsageSummary>> GetOrganizationSummaryTopSwitchesByEnergyUsageAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, string? networkTag = null, string? deviceTag = null, string? networkId = null, int? quantity = 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 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.

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

quantity int?

Set number of desired results to return. Default is 10.

ssidName string

Filter results by ssid name

usageUplink string

Filter results by usage uplink

cancellationToken CancellationToken

Returns

Task<List<EnergyUsageSummary>>

Exceptions

ApiException

Thrown when fails to make API call

Edit this page