All URIs are relative to https://api.meraki.com/api/v1
| Method | HTTP request | Description |
|---|---|---|
| GetOrganizationApiRequests | Get /organizations/{organizationId}/apiRequests | List the API requests made by an organization |
| GetOrganizationApiRequestsOverview | Get /organizations/{organizationId}/apiRequests/overview | Return an aggregated overview of API requests data |
| GetOrganizationApiRequestsOverviewResponseCodesByInterval | Get /organizations/{organizationId}/apiRequests/overview/responseCodes/byInterval | Tracks organizations' API requests by response code across a given time period |
[]GetOrganizationApiRequests200ResponseInner GetOrganizationApiRequests(ctx, organizationId).T0(t0).T1(t1).Timespan(timespan).PerPage(perPage).StartingAfter(startingAfter).EndingBefore(endingBefore).AdminId(adminId).Path(path).Method(method).ResponseCode(responseCode).SourceIp(sourceIp).UserAgent(userAgent).Version(version).OperationIds(operationIds).Execute()
List the API requests made by an organization
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/meraki/dashboard-api-go/client"
)
func main() {
organizationId := "organizationId_example" // string | Organization ID
t0 := "t0_example" // string | The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
t1 := "t1_example" // string | The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
timespan := float32(3.4) // float32 | 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 := int32(56) // int32 | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
startingAfter := "startingAfter_example" // 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 := "endingBefore_example" // 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 := "adminId_example" // string | Filter the results by the ID of the admin who made the API requests (optional)
path := "path_example" // string | Filter the results by the path of the API requests (optional)
method := "method_example" // string | Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
responseCode := int32(56) // int32 | Filter the results by the response code of the API requests (optional)
sourceIp := "sourceIp_example" // string | Filter the results by the IP address of the originating API request (optional)
userAgent := "userAgent_example" // string | Filter the results by the user agent string of the API request (optional)
version := int32(56) // int32 | Filter the results by the API version of the API request (optional)
operationIds := []string{"Inner_example"} // []string | Filter the results by one or more operation IDs for the API request (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ApiRequestsApi.GetOrganizationApiRequests(context.Background(), organizationId).T0(t0).T1(t1).Timespan(timespan).PerPage(perPage).StartingAfter(startingAfter).EndingBefore(endingBefore).AdminId(adminId).Path(path).Method(method).ResponseCode(responseCode).SourceIp(sourceIp).UserAgent(userAgent).Version(version).OperationIds(operationIds).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApiRequestsApi.GetOrganizationApiRequests``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOrganizationApiRequests`: []GetOrganizationApiRequests200ResponseInner
fmt.Fprintf(os.Stdout, "Response from `ApiRequestsApi.GetOrganizationApiRequests`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| organizationId | string | Organization ID |
Other parameters are passed through a pointer to a apiGetOrganizationApiRequestsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
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 | float32 | 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. | perPage | int32 | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. | 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. | adminId | string | Filter the results by the ID of the admin who made the API requests | path | string | Filter the results by the path of the API requests | method | string | Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') | responseCode | int32 | Filter the results by the response code of the API requests | sourceIp | string | Filter the results by the IP address of the originating API request | userAgent | string | Filter the results by the user agent string of the API request | version | int32 | Filter the results by the API version of the API request | operationIds | []string | Filter the results by one or more operation IDs for the API request |
[]GetOrganizationApiRequests200ResponseInner
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetOrganizationApiRequestsOverview200Response GetOrganizationApiRequestsOverview(ctx, organizationId).T0(t0).T1(t1).Timespan(timespan).Execute()
Return an aggregated overview of API requests data
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/meraki/dashboard-api-go/client"
)
func main() {
organizationId := "organizationId_example" // string | Organization ID
t0 := "t0_example" // string | The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
t1 := "t1_example" // string | The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
timespan := float32(3.4) // float32 | 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)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ApiRequestsApi.GetOrganizationApiRequestsOverview(context.Background(), organizationId).T0(t0).T1(t1).Timespan(timespan).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApiRequestsApi.GetOrganizationApiRequestsOverview``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOrganizationApiRequestsOverview`: GetOrganizationApiRequestsOverview200Response
fmt.Fprintf(os.Stdout, "Response from `ApiRequestsApi.GetOrganizationApiRequestsOverview`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| organizationId | string | Organization ID |
Other parameters are passed through a pointer to a apiGetOrganizationApiRequestsOverviewRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
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 | float32 | 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. |
GetOrganizationApiRequestsOverview200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]GetOrganizationApiRequestsOverviewResponseCodesByInterval200ResponseInner GetOrganizationApiRequestsOverviewResponseCodesByInterval(ctx, organizationId).T0(t0).T1(t1).Timespan(timespan).Interval(interval).Version(version).OperationIds(operationIds).SourceIps(sourceIps).AdminIds(adminIds).UserAgent(userAgent).Execute()
Tracks organizations' API requests by response code across a given time period
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/meraki/dashboard-api-go/client"
)
func main() {
organizationId := "organizationId_example" // string | Organization ID
t0 := "t0_example" // string | The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
t1 := "t1_example" // string | The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
timespan := float32(3.4) // float32 | 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. If interval is provided, the timespan will be autocalculated. (optional)
interval := int32(56) // int32 | 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. (optional)
version := int32(56) // int32 | Filter by API version of the endpoint. Allowable values are: [0, 1] (optional)
operationIds := []string{"Inner_example"} // []string | Filter by operation ID of the endpoint (optional)
sourceIps := []string{"Inner_example"} // []string | Filter by source IP that made the API request (optional)
adminIds := []string{"Inner_example"} // []string | Filter by admin ID of user that made the API request (optional)
userAgent := "userAgent_example" // string | Filter by user agent string for API request. This will filter by a complete or partial match. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ApiRequestsApi.GetOrganizationApiRequestsOverviewResponseCodesByInterval(context.Background(), organizationId).T0(t0).T1(t1).Timespan(timespan).Interval(interval).Version(version).OperationIds(operationIds).SourceIps(sourceIps).AdminIds(adminIds).UserAgent(userAgent).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApiRequestsApi.GetOrganizationApiRequestsOverviewResponseCodesByInterval``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOrganizationApiRequestsOverviewResponseCodesByInterval`: []GetOrganizationApiRequestsOverviewResponseCodesByInterval200ResponseInner
fmt.Fprintf(os.Stdout, "Response from `ApiRequestsApi.GetOrganizationApiRequestsOverviewResponseCodesByInterval`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| organizationId | string | Organization ID |
Other parameters are passed through a pointer to a apiGetOrganizationApiRequestsOverviewResponseCodesByIntervalRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
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 | float32 | 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. If interval is provided, the timespan will be autocalculated. | interval | int32 | 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 | int32 | Filter by API version of the endpoint. Allowable values are: [0, 1] | operationIds | []string | Filter by operation ID of the endpoint | sourceIps | []string | Filter by source IP that made the API request | adminIds | []string | Filter by admin ID of user that made the API request | userAgent | string | Filter by user agent string for API request. This will filter by a complete or partial match. |
[]GetOrganizationApiRequestsOverviewResponseCodesByInterval200ResponseInner
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]