1. Packages
  2. Cisco Meraki Provider
  3. API Docs
  4. networks
  5. getWirelessDataRateHistory
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

meraki.networks.getWirelessDataRateHistory

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = meraki.networks.getWirelessDataRateHistory({
    apTag: "string",
    autoResolution: false,
    band: "string",
    clientId: "string",
    deviceSerial: "string",
    networkId: "string",
    resolution: 1,
    ssid: 1,
    t0: "string",
    t1: "string",
    timespan: 1,
});
export const merakiNetworksWirelessDataRateHistoryExample = example.then(example => example.items);
Copy
import pulumi
import pulumi_meraki as meraki

example = meraki.networks.get_wireless_data_rate_history(ap_tag="string",
    auto_resolution=False,
    band="string",
    client_id="string",
    device_serial="string",
    network_id="string",
    resolution=1,
    ssid=1,
    t0="string",
    t1="string",
    timespan=1)
pulumi.export("merakiNetworksWirelessDataRateHistoryExample", example.items)
Copy
package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.GetWirelessDataRateHistory(ctx, &networks.GetWirelessDataRateHistoryArgs{
			ApTag:          pulumi.StringRef("string"),
			AutoResolution: pulumi.BoolRef(false),
			Band:           pulumi.StringRef("string"),
			ClientId:       pulumi.StringRef("string"),
			DeviceSerial:   pulumi.StringRef("string"),
			NetworkId:      "string",
			Resolution:     pulumi.IntRef(1),
			Ssid:           pulumi.IntRef(1),
			T0:             pulumi.StringRef("string"),
			T1:             pulumi.StringRef("string"),
			Timespan:       pulumi.Float64Ref(1),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksWirelessDataRateHistoryExample", example.Items)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Networks.GetWirelessDataRateHistory.Invoke(new()
    {
        ApTag = "string",
        AutoResolution = false,
        Band = "string",
        ClientId = "string",
        DeviceSerial = "string",
        NetworkId = "string",
        Resolution = 1,
        Ssid = 1,
        T0 = "string",
        T1 = "string",
        Timespan = 1,
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksWirelessDataRateHistoryExample"] = example.Apply(getWirelessDataRateHistoryResult => getWirelessDataRateHistoryResult.Items),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.NetworksFunctions;
import com.pulumi.meraki.networks.inputs.GetWirelessDataRateHistoryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = NetworksFunctions.getWirelessDataRateHistory(GetWirelessDataRateHistoryArgs.builder()
            .apTag("string")
            .autoResolution(false)
            .band("string")
            .clientId("string")
            .deviceSerial("string")
            .networkId("string")
            .resolution(1)
            .ssid(1)
            .t0("string")
            .t1("string")
            .timespan(1)
            .build());

        ctx.export("merakiNetworksWirelessDataRateHistoryExample", example.applyValue(getWirelessDataRateHistoryResult -> getWirelessDataRateHistoryResult.items()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: meraki:networks:getWirelessDataRateHistory
      arguments:
        apTag: string
        autoResolution: false
        band: string
        clientId: string
        deviceSerial: string
        networkId: string
        resolution: 1
        ssid: 1
        t0: string
        t1: string
        timespan: 1
outputs:
  merakiNetworksWirelessDataRateHistoryExample: ${example.items}
Copy

Using getWirelessDataRateHistory

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWirelessDataRateHistory(args: GetWirelessDataRateHistoryArgs, opts?: InvokeOptions): Promise<GetWirelessDataRateHistoryResult>
function getWirelessDataRateHistoryOutput(args: GetWirelessDataRateHistoryOutputArgs, opts?: InvokeOptions): Output<GetWirelessDataRateHistoryResult>
Copy
def get_wireless_data_rate_history(ap_tag: Optional[str] = None,
                                   auto_resolution: Optional[bool] = None,
                                   band: Optional[str] = None,
                                   client_id: Optional[str] = None,
                                   device_serial: Optional[str] = None,
                                   network_id: Optional[str] = None,
                                   resolution: Optional[int] = None,
                                   ssid: Optional[int] = None,
                                   t0: Optional[str] = None,
                                   t1: Optional[str] = None,
                                   timespan: Optional[float] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetWirelessDataRateHistoryResult
def get_wireless_data_rate_history_output(ap_tag: Optional[pulumi.Input[str]] = None,
                                   auto_resolution: Optional[pulumi.Input[bool]] = None,
                                   band: Optional[pulumi.Input[str]] = None,
                                   client_id: Optional[pulumi.Input[str]] = None,
                                   device_serial: Optional[pulumi.Input[str]] = None,
                                   network_id: Optional[pulumi.Input[str]] = None,
                                   resolution: Optional[pulumi.Input[int]] = None,
                                   ssid: Optional[pulumi.Input[int]] = None,
                                   t0: Optional[pulumi.Input[str]] = None,
                                   t1: Optional[pulumi.Input[str]] = None,
                                   timespan: Optional[pulumi.Input[float]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetWirelessDataRateHistoryResult]
Copy
func GetWirelessDataRateHistory(ctx *Context, args *GetWirelessDataRateHistoryArgs, opts ...InvokeOption) (*GetWirelessDataRateHistoryResult, error)
func GetWirelessDataRateHistoryOutput(ctx *Context, args *GetWirelessDataRateHistoryOutputArgs, opts ...InvokeOption) GetWirelessDataRateHistoryResultOutput
Copy

> Note: This function is named GetWirelessDataRateHistory in the Go SDK.

public static class GetWirelessDataRateHistory 
{
    public static Task<GetWirelessDataRateHistoryResult> InvokeAsync(GetWirelessDataRateHistoryArgs args, InvokeOptions? opts = null)
    public static Output<GetWirelessDataRateHistoryResult> Invoke(GetWirelessDataRateHistoryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWirelessDataRateHistoryResult> getWirelessDataRateHistory(GetWirelessDataRateHistoryArgs args, InvokeOptions options)
public static Output<GetWirelessDataRateHistoryResult> getWirelessDataRateHistory(GetWirelessDataRateHistoryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: meraki:networks/getWirelessDataRateHistory:getWirelessDataRateHistory
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NetworkId This property is required. string
networkId path parameter. Network ID
ApTag string
apTag query parameter. Filter results by AP tag.
AutoResolution bool
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
Band string
band query parameter. Filter results by band (either '2.4', '5' or '6').
ClientId string
clientId query parameter. Filter results by network client.
DeviceSerial string
deviceSerial query parameter. Filter results by device.
Resolution int
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
Ssid int
ssid query parameter. Filter results by SSID number.
T0 string
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
T1 string
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
Timespan double
timespan query parameter. 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.
NetworkId This property is required. string
networkId path parameter. Network ID
ApTag string
apTag query parameter. Filter results by AP tag.
AutoResolution bool
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
Band string
band query parameter. Filter results by band (either '2.4', '5' or '6').
ClientId string
clientId query parameter. Filter results by network client.
DeviceSerial string
deviceSerial query parameter. Filter results by device.
Resolution int
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
Ssid int
ssid query parameter. Filter results by SSID number.
T0 string
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
T1 string
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
Timespan float64
timespan query parameter. 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.
networkId This property is required. String
networkId path parameter. Network ID
apTag String
apTag query parameter. Filter results by AP tag.
autoResolution Boolean
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
band String
band query parameter. Filter results by band (either '2.4', '5' or '6').
clientId String
clientId query parameter. Filter results by network client.
deviceSerial String
deviceSerial query parameter. Filter results by device.
resolution Integer
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
ssid Integer
ssid query parameter. Filter results by SSID number.
t0 String
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 String
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan Double
timespan query parameter. 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.
networkId This property is required. string
networkId path parameter. Network ID
apTag string
apTag query parameter. Filter results by AP tag.
autoResolution boolean
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
band string
band query parameter. Filter results by band (either '2.4', '5' or '6').
clientId string
clientId query parameter. Filter results by network client.
deviceSerial string
deviceSerial query parameter. Filter results by device.
resolution number
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
ssid number
ssid query parameter. Filter results by SSID number.
t0 string
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 string
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan number
timespan query parameter. 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.
network_id This property is required. str
networkId path parameter. Network ID
ap_tag str
apTag query parameter. Filter results by AP tag.
auto_resolution bool
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
band str
band query parameter. Filter results by band (either '2.4', '5' or '6').
client_id str
clientId query parameter. Filter results by network client.
device_serial str
deviceSerial query parameter. Filter results by device.
resolution int
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
ssid int
ssid query parameter. Filter results by SSID number.
t0 str
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 str
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan float
timespan query parameter. 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.
networkId This property is required. String
networkId path parameter. Network ID
apTag String
apTag query parameter. Filter results by AP tag.
autoResolution Boolean
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
band String
band query parameter. Filter results by band (either '2.4', '5' or '6').
clientId String
clientId query parameter. Filter results by network client.
deviceSerial String
deviceSerial query parameter. Filter results by device.
resolution Number
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
ssid Number
ssid query parameter. Filter results by SSID number.
t0 String
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 String
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan Number
timespan query parameter. 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.

getWirelessDataRateHistory Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Items List<GetWirelessDataRateHistoryItem>
Array of ResponseWirelessGetNetworkWirelessDataRateHistory
NetworkId string
networkId path parameter. Network ID
ApTag string
apTag query parameter. Filter results by AP tag.
AutoResolution bool
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
Band string
band query parameter. Filter results by band (either '2.4', '5' or '6').
ClientId string
clientId query parameter. Filter results by network client.
DeviceSerial string
deviceSerial query parameter. Filter results by device.
Resolution int
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
Ssid int
ssid query parameter. Filter results by SSID number.
T0 string
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
T1 string
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
Timespan double
timespan query parameter. 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.
Id string
The provider-assigned unique ID for this managed resource.
Items []GetWirelessDataRateHistoryItem
Array of ResponseWirelessGetNetworkWirelessDataRateHistory
NetworkId string
networkId path parameter. Network ID
ApTag string
apTag query parameter. Filter results by AP tag.
AutoResolution bool
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
Band string
band query parameter. Filter results by band (either '2.4', '5' or '6').
ClientId string
clientId query parameter. Filter results by network client.
DeviceSerial string
deviceSerial query parameter. Filter results by device.
Resolution int
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
Ssid int
ssid query parameter. Filter results by SSID number.
T0 string
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
T1 string
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
Timespan float64
timespan query parameter. 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.
id String
The provider-assigned unique ID for this managed resource.
items List<GetWirelessDataRateHistoryItem>
Array of ResponseWirelessGetNetworkWirelessDataRateHistory
networkId String
networkId path parameter. Network ID
apTag String
apTag query parameter. Filter results by AP tag.
autoResolution Boolean
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
band String
band query parameter. Filter results by band (either '2.4', '5' or '6').
clientId String
clientId query parameter. Filter results by network client.
deviceSerial String
deviceSerial query parameter. Filter results by device.
resolution Integer
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
ssid Integer
ssid query parameter. Filter results by SSID number.
t0 String
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 String
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan Double
timespan query parameter. 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.
id string
The provider-assigned unique ID for this managed resource.
items GetWirelessDataRateHistoryItem[]
Array of ResponseWirelessGetNetworkWirelessDataRateHistory
networkId string
networkId path parameter. Network ID
apTag string
apTag query parameter. Filter results by AP tag.
autoResolution boolean
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
band string
band query parameter. Filter results by band (either '2.4', '5' or '6').
clientId string
clientId query parameter. Filter results by network client.
deviceSerial string
deviceSerial query parameter. Filter results by device.
resolution number
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
ssid number
ssid query parameter. Filter results by SSID number.
t0 string
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 string
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan number
timespan query parameter. 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.
id str
The provider-assigned unique ID for this managed resource.
items Sequence[GetWirelessDataRateHistoryItem]
Array of ResponseWirelessGetNetworkWirelessDataRateHistory
network_id str
networkId path parameter. Network ID
ap_tag str
apTag query parameter. Filter results by AP tag.
auto_resolution bool
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
band str
band query parameter. Filter results by band (either '2.4', '5' or '6').
client_id str
clientId query parameter. Filter results by network client.
device_serial str
deviceSerial query parameter. Filter results by device.
resolution int
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
ssid int
ssid query parameter. Filter results by SSID number.
t0 str
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 str
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan float
timespan query parameter. 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.
id String
The provider-assigned unique ID for this managed resource.
items List<Property Map>
Array of ResponseWirelessGetNetworkWirelessDataRateHistory
networkId String
networkId path parameter. Network ID
apTag String
apTag query parameter. Filter results by AP tag.
autoResolution Boolean
autoResolution query parameter. Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
band String
band query parameter. Filter results by band (either '2.4', '5' or '6').
clientId String
clientId query parameter. Filter results by network client.
deviceSerial String
deviceSerial query parameter. Filter results by device.
resolution Number
resolution query parameter. The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
ssid Number
ssid query parameter. Filter results by SSID number.
t0 String
t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 String
t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan Number
timespan query parameter. 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.

Supporting Types

GetWirelessDataRateHistoryItem

AverageKbps This property is required. int
Average data rate in kilobytes-per-second
DownloadKbps This property is required. int
Download rate in kilobytes-per-second
EndTs This property is required. string
The end time of the query range
StartTs This property is required. string
The start time of the query range
UploadKbps This property is required. int
Upload rate in kilobytes-per-second
AverageKbps This property is required. int
Average data rate in kilobytes-per-second
DownloadKbps This property is required. int
Download rate in kilobytes-per-second
EndTs This property is required. string
The end time of the query range
StartTs This property is required. string
The start time of the query range
UploadKbps This property is required. int
Upload rate in kilobytes-per-second
averageKbps This property is required. Integer
Average data rate in kilobytes-per-second
downloadKbps This property is required. Integer
Download rate in kilobytes-per-second
endTs This property is required. String
The end time of the query range
startTs This property is required. String
The start time of the query range
uploadKbps This property is required. Integer
Upload rate in kilobytes-per-second
averageKbps This property is required. number
Average data rate in kilobytes-per-second
downloadKbps This property is required. number
Download rate in kilobytes-per-second
endTs This property is required. string
The end time of the query range
startTs This property is required. string
The start time of the query range
uploadKbps This property is required. number
Upload rate in kilobytes-per-second
average_kbps This property is required. int
Average data rate in kilobytes-per-second
download_kbps This property is required. int
Download rate in kilobytes-per-second
end_ts This property is required. str
The end time of the query range
start_ts This property is required. str
The start time of the query range
upload_kbps This property is required. int
Upload rate in kilobytes-per-second
averageKbps This property is required. Number
Average data rate in kilobytes-per-second
downloadKbps This property is required. Number
Download rate in kilobytes-per-second
endTs This property is required. String
The end time of the query range
startTs This property is required. String
The start time of the query range
uploadKbps This property is required. Number
Upload rate in kilobytes-per-second

Package Details

Repository
meraki pulumi/pulumi-meraki
License
Apache-2.0
Notes
This Pulumi package is based on the meraki Terraform Provider.