Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 5.3 KB

DataRateHistoryApi.md

File metadata and controls

100 lines (69 loc) · 5.3 KB

\DataRateHistoryApi

All URIs are relative to https://api.meraki.com/api/v1

Method HTTP request Description
GetNetworkWirelessDataRateHistory Get /networks/{networkId}/wireless/dataRateHistory Return PHY data rates over time for a network, device, or network client

GetNetworkWirelessDataRateHistory

[]GetNetworkWirelessDataRateHistory200ResponseInner GetNetworkWirelessDataRateHistory(ctx, networkId).T0(t0).T1(t1).Timespan(timespan).Resolution(resolution).AutoResolution(autoResolution).ClientId(clientId).DeviceSerial(deviceSerial).ApTag(apTag).Band(band).Ssid(ssid).Execute()

Return PHY data rates over time for a network, device, or network client

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/meraki/dashboard-api-go/client"
)

func main() {
    networkId := "networkId_example" // string | Network 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 7 days. (optional)
    resolution := int32(56) // int32 | The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
    autoResolution := true // bool | Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
    clientId := "clientId_example" // string | Filter results by network client. (optional)
    deviceSerial := "deviceSerial_example" // string | Filter results by device. (optional)
    apTag := "apTag_example" // string | Filter results by AP tag. (optional)
    band := "band_example" // string | Filter results by band (either '2.4', '5' or '6'). (optional)
    ssid := int32(56) // int32 | Filter results by SSID number. (optional)

    configuration := openapiclient.NewConfiguration()

    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataRateHistoryApi.GetNetworkWirelessDataRateHistory(context.Background(), networkId).T0(t0).T1(t1).Timespan(timespan).Resolution(resolution).AutoResolution(autoResolution).ClientId(clientId).DeviceSerial(deviceSerial).ApTag(apTag).Band(band).Ssid(ssid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataRateHistoryApi.GetNetworkWirelessDataRateHistory``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNetworkWirelessDataRateHistory`: []GetNetworkWirelessDataRateHistory200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `DataRateHistoryApi.GetNetworkWirelessDataRateHistory`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId string Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetNetworkWirelessDataRateHistoryRequest 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 7 days. | resolution | int32 | The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. | autoResolution | bool | Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. | clientId | string | Filter results by network client. | deviceSerial | string | Filter results by device. | apTag | string | Filter results by AP tag. | band | string | Filter results by band (either '2.4', '5' or '6'). | ssid | int32 | Filter results by SSID number. |

Return type

[]GetNetworkWirelessDataRateHistory200ResponseInner

Authorization

bearerAuth, meraki_api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]