{"type":"api","title":"Get Network Wireless Client Latency History","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/4723762d29b3380de018ae8c0d8a59499a6523e0/5c63a5d4-9452-397a-85eb-8b6fec45147e","info":{"title":"Meraki Dashboard API","description":"A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n> Date: 03 July, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n","contact":{"name":"Meraki Developer Community","url":"https://meraki.io/community"},"version":"1.48.0"},"security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"tags":[{"name":"organizations"},{"name":"networks"},{"name":"devices"},{"name":"insight"},{"name":"wireless"},{"name":"camera"},{"name":"appliance"},{"name":"switch"},{"name":"cellularGateway"},{"name":"sm"},{"name":"sensor"},{"name":"administered"},{"name":"accessControlLists"},{"name":"accessPolicies"},{"name":"acls"},{"name":"actionBatches"},{"name":"adaptivePolicy"},{"name":"addresses"},{"name":"admins"},{"name":"airMarshal"},{"name":"alertTypes"},{"name":"alerts"},{"name":"alternateManagementInterface"},{"name":"analytics"},{"name":"apiRequests"},{"name":"apnsCert"},{"name":"appliances"},{"name":"applicationCategories"},{"name":"applicationUsage"},{"name":"applications"},{"name":"areas"},{"name":"arpInspection"},{"name":"arpTable"},{"name":"artifacts"},{"name":"assets"},{"name":"assignments"},{"name":"authenticationToken"},{"name":"availabilities"},{"name":"bandwidthUsageHistory"},{"name":"bgp"},{"name":"billing"},{"name":"bluetooth"},{"name":"bluetoothClients"},{"name":"bonjourForwarding"},{"name":"boundaries"},{"name":"brandingPolicies"},{"name":"bulk"},{"name":"bulkUpdate"},{"name":"byBoundary"},{"name":"byClient"},{"name":"byDevice"},{"name":"byEnergyUsage"},{"name":"byInterval"},{"name":"byMetric"},{"name":"byModel"},{"name":"byNetwork"},{"name":"byStatus"},{"name":"bySwitch"},{"name":"byType"},{"name":"byUsage"},{"name":"byUtilization"},{"name":"bypassActivationLockAttempts"},{"name":"cableTest"},{"name":"callbacks"},{"name":"categories"},{"name":"cellular"},{"name":"cellularFirewallRules"},{"name":"cellularUsageHistory"},{"name":"certs"},{"name":"changeHistory"},{"name":"channelUtilization"},{"name":"channelUtilizationHistory"},{"name":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clients"},{"name":"cloudMonitoring"},{"name":"commands"},{"name":"compliance"},{"name":"configTemplates"},{"name":"configurationChanges"},{"name":"configure"},{"name":"configuredDevices"},{"name":"connectionStats"},{"name":"connectivity"},{"name":"connectivityEvents"},{"name":"connectivityMonitoringDestinations"},{"name":"contentFiltering"},{"name":"coterm"},{"name":"current"},{"name":"customAnalytics"},{"name":"customPerformanceClasses"},{"name":"dataRateHistory"},{"name":"delegated"},{"name":"desktopLogs"},{"name":"details"},{"name":"detections"},{"name":"deviceCommandLogs"},{"name":"deviceProfiles"},{"name":"deviceTypeGroupPolicies"},{"name":"dhcp"},{"name":"dhcpServerPolicy"},{"name":"dscpTaggingOptions"},{"name":"dscpToCosMappings"},{"name":"eapOverride"},{"name":"earlyAccess"},{"name":"electronicShelfLabel"},{"name":"entitlements"},{"name":"ethernet"},{"name":"eventTypes"},{"name":"events"},{"name":"exportEvents"},{"name":"failedConnections"},{"name":"features"},{"name":"fields"},{"name":"firewall"},{"name":"firewalledServices"},{"name":"firmware"},{"name":"firmwareUpgrades"},{"name":"floorPlans"},{"name":"groupPolicies"},{"name":"groups"},{"name":"health"},{"name":"healthByTime"},{"name":"historical"},{"name":"history"},{"name":"hotspot20"},{"name":"httpServers"},{"name":"identities"},{"name":"identityPsks"},{"name":"idps"},{"name":"imports"},{"name":"inboundCellularFirewallRules"},{"name":"inboundFirewallRules"},{"name":"interfaces"},{"name":"internetPolicies"},{"name":"intrusion"},{"name":"inventory"},{"name":"ipv6"},{"name":"l3FirewallRules"},{"name":"l7FirewallRules"},{"name":"lan"},{"name":"latencyHistory"},{"name":"latencyStats"},{"name":"latest"},{"name":"licenses"},{"name":"licensing"},{"name":"lines"},{"name":"linkAggregations"},{"name":"linkLayer"},{"name":"live"},{"name":"liveTools"},{"name":"lldpCdp"},{"name":"loginSecurity"},{"name":"logs"},{"name":"lossAndLatencyHistory"},{"name":"malware"},{"name":"managementInterface"},{"name":"manufacturers"},{"name":"me"},{"name":"merakiAuthUsers"},{"name":"meshStatuses"},{"name":"models"},{"name":"monitor"},{"name":"monitoredMediaServers"},{"name":"mqttBrokers"},{"name":"mtu"},{"name":"multicast"},{"name":"netflow"},{"name":"networkAdapters"},{"name":"networkHealth"},{"name":"objectDetectionModels"},{"name":"onboarding"},{"name":"oneToManyNatRules"},{"name":"oneToOneNatRules"},{"name":"openapiSpec"},{"name":"optIns"},{"name":"order"},{"name":"ospf"},{"name":"overview"},{"name":"packetLoss"},{"name":"packets"},{"name":"payloadTemplates"},{"name":"performance"},{"name":"performanceHistory"},{"name":"permissions"},{"name":"pii"},{"name":"piiKeys"},{"name":"ping"},{"name":"pingDevice"},{"name":"policies"},{"name":"policy"},{"name":"policyObjects"},{"name":"portForwardingRules"},{"name":"portSchedules"},{"name":"ports"},{"name":"power"},{"name":"powerModules"},{"name":"prefixes"},{"name":"prepare"},{"name":"priorities"},{"name":"profiles"},{"name":"provisioning"},{"name":"qosRules"},{"name":"qualityAndRetention"},{"name":"qualityRetentionProfiles"},{"name":"radio"},{"name":"readings"},{"name":"recent"},{"name":"relationships"},{"name":"rendezvousPoints"},{"name":"requests"},{"name":"responseCodes"},{"name":"restrictions"},{"name":"rfProfiles"},{"name":"roles"},{"name":"rollbacks"},{"name":"routing"},{"name":"rules"},{"name":"saml"},{"name":"samlRoles"},{"name":"schedules"},{"name":"sdwan"},{"name":"search"},{"name":"security"},{"name":"securityCenters"},{"name":"seen"},{"name":"sense"},{"name":"sentry"},{"name":"servers"},{"name":"settings"},{"name":"signalQualityHistory"},{"name":"sims"},{"name":"singleLan"},{"name":"siteToSiteVpn"},{"name":"smDevicesForKey"},{"name":"smOwnersForKey"},{"name":"snmp"},{"name":"softwares"},{"name":"splash"},{"name":"splashAuthorizationStatus"},{"name":"splashLoginAttempts"},{"name":"ssids"},{"name":"stacks"},{"name":"staged"},{"name":"stages"},{"name":"staticRoutes"},{"name":"statics"},{"name":"stats"},{"name":"status"},{"name":"statuses"},{"name":"stormControl"},{"name":"stp"},{"name":"subnetPool"},{"name":"subnets"},{"name":"subscription"},{"name":"subscriptions"},{"name":"summary"},{"name":"swaps"},{"name":"switches"},{"name":"syslogServers"},{"name":"targetGroups"},{"name":"themes"},{"name":"thirdPartyVPNPeers"},{"name":"throughputTest"},{"name":"top"},{"name":"topology"},{"name":"traffic"},{"name":"trafficAnalysis"},{"name":"trafficHistory"},{"name":"trafficShaping"},{"name":"trustedAccessConfigs"},{"name":"trustedServers"},{"name":"upgrades"},{"name":"uplink"},{"name":"uplinkBandwidth"},{"name":"uplinkSelection"},{"name":"uplinks"},{"name":"uplinksLossAndLatency"},{"name":"usage"},{"name":"usageHistories"},{"name":"usageHistory"},{"name":"userAccessDevices"},{"name":"users"},{"name":"v4"},{"name":"video"},{"name":"videoLink"},{"name":"vlanAssignments"},{"name":"vlanProfiles"},{"name":"vlans"},{"name":"vmx"},{"name":"vpn"},{"name":"vpnExclusions"},{"name":"vpnFirewallRules"},{"name":"vppAccounts"},{"name":"wakeOnLan"},{"name":"warmSpare"},{"name":"warnings"},{"name":"webhookTests"},{"name":"webhooks"},{"name":"wirelessProfiles"},{"name":"wlanLists"},{"name":"zones"}],"x-parser-conf":{"overview":{"markdownPath":"docs/overview.md"},"theme":"meraki","serverConfig":true,"meta":{"useProxy":true},"httpBearer":{"bearerToken":"75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}},"groupBy":{"$remoteModule":"config/group_platform.js"},"sortBy":{"$remoteModule":"config/sort_by.js"},"exampleAsDefault":true,"expand":3,"sampleCode":{"python":{"folder":"meraki/sdk/python","name":"Meraki Python Library","highlight":"python"}},"variables":{"organizationId":"1215707","networkId":"N_784752235069315754","serial":"QBSB-VQ3J-XZ54"}},"openapi":"3.0.1","servers":[{"url":"https://api.meraki.com/{basePath}","variables":{"basePath":{"default":"api/v1"}}}],"securitySchemes":{"meraki_api_key":{"type":"apiKey","name":"X-Cisco-Meraki-API-Key","in":"header"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key"}}},"spec":{"description":"Return the latency history for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. The latency data is from a sample of 2% of packets and is grouped into 4 traffic categories: background, best effort, video, voice. Within these categories the sampled packet counters are bucketed by latency in milliseconds.","operationId":"getNetworkWirelessClientLatencyHistory","parameters":[{"name":"networkId","in":"path","description":"Network ID","schema":{"type":"string"},"required":true},{"name":"clientId","in":"path","description":"Client ID","schema":{"type":"string"},"required":true},{"name":"t0","in":"query","description":"The beginning of the timespan for the data. The maximum lookback period is 791 days from today.","schema":{"type":"string"}},{"name":"t1","in":"query","description":"The end of the timespan for the data. t1 can be a maximum of 791 days after t0.","schema":{"type":"string"}},{"name":"timespan","in":"query","description":"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 791 days. The default is 1 day.","schema":{"type":"number","format":"float","maximum":68342400}},{"name":"resolution","in":"query","description":"The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"t0":{"type":"integer","description":"The latency history bucket start time in seconds"},"t1":{"type":"integer","description":"The latency history bucket end time in seconds"},"latencyBinsByCategory":{"type":"object","properties":{"backgroundTraffic":{"type":"object","properties":{"0.5":{"type":"integer","description":"The latency bucket for background traffic in 0.5 seconds"},"1.0":{"type":"integer","description":"The latency bucket for background traffic in 1.0 seconds"},"2.0":{"type":"integer","description":"The latency bucket for background traffic in 2.0 seconds"},"4.0":{"type":"integer","description":"The latency bucket for background traffic in 4.0 seconds"},"8.0":{"type":"integer","description":"The latency bucket for background traffic in 8.0 seconds"},"16.0":{"type":"integer","description":"The latency bucket for background traffic in 16.0 seconds"},"32.0":{"type":"integer","description":"The latency bucket for background traffic in 32.0 seconds"},"64.0":{"type":"integer","description":"The latency bucket for background traffic in 64.0 seconds"},"128.0":{"type":"integer","description":"The latency bucket for background traffic in 128.0 seconds"},"256.0":{"type":"integer","description":"The latency bucket for background traffic in 256.0 seconds"},"512.0":{"type":"integer","description":"The latency bucket for background traffic in 512.0 seconds"},"1024.0":{"type":"integer","description":"The latency bucket for background traffic in 1024.0 seconds"},"2048.0":{"type":"integer","description":"The latency bucket for background traffic in 2048.0 seconds"}},"description":"The time bucket's background traffic latency history"},"bestEffortTraffic":{"type":"object","properties":{"0.5":{"type":"integer","description":"The latency bucket for best effort traffic in 0.5 seconds"},"1.0":{"type":"integer","description":"The latency bucket for best effort traffic in 1.0 seconds"},"2.0":{"type":"integer","description":"The latency bucket for best effort traffic in 2.0 seconds"},"4.0":{"type":"integer","description":"The latency bucket for best effort traffic in 4.0 seconds"},"8.0":{"type":"integer","description":"The latency bucket for best effort traffic in 8.0 seconds"},"16.0":{"type":"integer","description":"The latency bucket for best effort traffic in 16.0 seconds"},"32.0":{"type":"integer","description":"The latency bucket for best effort traffic in 32.0 seconds"},"64.0":{"type":"integer","description":"The latency bucket for best effort traffic in 64.0 seconds"},"128.0":{"type":"integer","description":"The latency bucket for best effort traffic in 128.0 seconds"},"256.0":{"type":"integer","description":"The latency bucket for best effort traffic in 256.0 seconds"},"512.0":{"type":"integer","description":"The latency bucket for best effort traffic in 512.0 seconds"},"1024.0":{"type":"integer","description":"The latency bucket for best effort traffic in 1024.0 seconds"},"2048.0":{"type":"integer","description":"The latency bucket for best effort traffic in 2048.0 seconds"}},"description":"The time bucket's best effort traffic latency history"},"videoTraffic":{"type":"object","properties":{"0.5":{"type":"integer","description":"The latency bucket for video traffic in 0.5 seconds"},"1.0":{"type":"integer","description":"The latency bucket for video traffic in 1.0 seconds"},"2.0":{"type":"integer","description":"The latency bucket for video traffic in 2.0 seconds"},"4.0":{"type":"integer","description":"The latency bucket for video traffic in 4.0 seconds"},"8.0":{"type":"integer","description":"The latency bucket for video traffic in 8.0 seconds"},"16.0":{"type":"integer","description":"The latency bucket for video traffic in 16.0 seconds"},"32.0":{"type":"integer","description":"The latency bucket for video traffic in 32.0 seconds"},"64.0":{"type":"integer","description":"The latency bucket for video traffic in 64.0 seconds"},"128.0":{"type":"integer","description":"The latency bucket for video traffic in 128.0 seconds"},"256.0":{"type":"integer","description":"The latency bucket for video traffic in 256.0 seconds"},"512.0":{"type":"integer","description":"The latency bucket for video traffic in 512.0 seconds"},"1024.0":{"type":"integer","description":"The latency bucket for video traffic in 1024.0 seconds"},"2048.0":{"type":"integer","description":"The latency bucket for video traffic in 2048.0 seconds"}},"description":"The time bucket's video traffic latency history"},"voiceTraffic":{"type":"object","properties":{"0.5":{"type":"integer","description":"The latency bucket for voice traffic in 0.5 seconds"},"1.0":{"type":"integer","description":"The latency bucket for voice traffic in 1.0 seconds"},"2.0":{"type":"integer","description":"The latency bucket for voice traffic in 2.0 seconds"},"4.0":{"type":"integer","description":"The latency bucket for voice traffic in 4.0 seconds"},"8.0":{"type":"integer","description":"The latency bucket for voice traffic in 8.0 seconds"},"16.0":{"type":"integer","description":"The latency bucket for voice traffic in 16.0 seconds"},"32.0":{"type":"integer","description":"The latency bucket for voice traffic in 32.0 seconds"},"64.0":{"type":"integer","description":"The latency bucket for voice traffic in 64.0 seconds"},"128.0":{"type":"integer","description":"The latency bucket for voice traffic in 128.0 seconds"},"256.0":{"type":"integer","description":"The latency bucket for voice traffic in 256.0 seconds"},"512.0":{"type":"integer","description":"The latency bucket for voice traffic in 512.0 seconds"},"1024.0":{"type":"integer","description":"The latency bucket for voice traffic in 1024.0 seconds"},"2048.0":{"type":"integer","description":"The latency bucket for voice traffic in 2048.0 seconds"}},"description":"The time bucket's voice traffic latency history"}},"description":"The latency buckets by category"}}}},"example":[{"t0":1550534400,"t1":1550620800,"latencyBinsByCategory":{"backgroundTraffic":{"0.5":41750,"1.0":21552,"2.0":59940,"4.0":146622,"8.0":57354,"16.0":0,"32.0":9954,"64.0":0,"128.0":0,"256.0":1896,"512.0":0,"1024.0":0,"2048.0":0},"bestEffortTraffic":{"0.5":1840899,"1.0":1644506,"2.0":629958,"4.0":449564,"8.0":2009658,"16.0":1329568,"32.0":282168,"64.0":97573,"128.0":191977,"256.0":30560,"512.0":26032,"1024.0":4943,"2048.0":12072},"videoTraffic":{"0.5":0,"1.0":0,"2.0":0,"4.0":0,"8.0":0,"16.0":0,"32.0":0,"64.0":0,"128.0":0,"256.0":0,"512.0":0,"1024.0":0,"2048.0":0},"voiceTraffic":{"0.5":716,"1.0":948,"2.0":474,"4.0":78,"8.0":0,"16.0":0,"32.0":0,"64.0":0,"128.0":0,"256.0":0,"512.0":0,"1024.0":0,"2048.0":0}}}]}}}},"summary":"Return the latency history for a client","tags":["wireless","monitor","clients","latencyHistory"],"__originalOperationId":"getNetworkWirelessClientLatencyHistory","security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"method":"get","path":"/networks/{networkId}/wireless/clients/{clientId}/latencyHistory","sampleCode":{"Meraki Python Library":{"code":"import meraki\n\n# Defining your API key as a variable in source code is discouraged.\n# This API key is for a read-only docs-specific environment.\n# In your own code, use an environment variable as shown under the Usage section\n# @ https://github.com/meraki/dashboard-api-python/\n\nAPI_KEY = '75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6'\n\ndashboard = meraki.DashboardAPI(API_KEY)\n\nnetwork_id = 'L_646829496481105433'\nclient_id = ''\n\nresponse = dashboard.wireless.getNetworkWirelessClientLatencyHistory(\n network_id, client_id\n)\n\nprint(response)","highlight":"python"}}}}