Interface IOrganizationsApiRequests

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizationsApiRequests

Extension Methods

IOrganizationsApiRequestsExtensions.GetOrganizationApiRequestsAllAsync(IOrganizationsApiRequests, string, string?, string?, double?, string?, string?, string?, int?, string?, string?, int?, List<string>?, CancellationToken)

Methods

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

List the API requests made by an organization

[Get("/organizations/{organizationId}/apiRequests")]
Task<List<ApiUsage>> GetOrganizationApiRequestsAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, string? adminId = null, string? path = null, string? method = null, int? responseCode = null, string? sourceIp = null, string? userAgent = null, int? version = null, List<string>? operationIds = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

t0 string

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

t1 string

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

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 31 days. (optional)

perPage int?

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)

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. (optional)

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. (optional)

adminId string

Filter the results by the ID of the admin who made the API requests (optional)

path string

Filter the results by the path of the API requests (optional)

method string

Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)

responseCode int?

Filter the results by the response code of the API requests (optional)

sourceIp string

Filter the results by the IP address of the originating API request (optional)

userAgent string

Filter the results by the user agent string of the API request

version int?

Filter the results by the API version of the API request

operationIds List<string>

Filter the results by one or more operation IDs for the API request

cancellationToken CancellationToken

Returns

Task<List<ApiUsage>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationApiRequestsOverviewAsync(string, string, string, double?, CancellationToken)

Return an aggregated overview of API requests data

[Get("/organizations/{organizationId}/apiRequests/overview")]
Task<ApiUsageOverview> GetOrganizationApiRequestsOverviewAsync(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. The maximum lookback period is 31 days from today. (optional)

t1 string

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

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 31 days. (optional)

cancellationToken CancellationToken

Returns

Task<ApiUsageOverview>

Exceptions

ApiException

Thrown when fails to make API call

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

Tracks organizations' API requests by response code across a given time period

[Get("/organizations/{organizationId}/apiRequests/overview/responseCodes/byInterval")]
Task<List<ApiRequestsOverview>> GetOrganizationApiRequestsOverviewResponseCodesByIntervalAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, int? interval = null, int? version = null, List<string>? operationIds = null, List<string>? sourceIps = null, List<string>? adminIds = null, List<string>? userAgent = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

t0 string

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

t1 string

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

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 31 days. (optional)

interval int?

The time interval in seconds for returned data. The valid intervals are: 120, 3600, 14400, 21600. The default is 21600. Interval is calculated if time params are provided.

version int?

Filter by API version of the endpoint. Allowable values are: [0, 1]

operationIds List<string>

Filter by operation ID of the endpoint

sourceIps List<string>

Filter by source IP that made the API request

adminIds List<string>

Filter by admin ID of user that made the API request

userAgent List<string>

Filter by user agent string for API request. This will filter by a complete or partial match.

cancellationToken CancellationToken

Returns

Task<List<ApiRequestsOverview>>

Exceptions

ApiException

Thrown when fails to make API call