{"type":"api","title":"Get Organization Assurance Alerts Overview Historical","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/e92a64d0814b40091de22f4a93378df69809b95e/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\u003e Date: 06 November, 2024\n\u003e\n\u003e [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.52.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":"wirelessController"},{"name":"policy"},{"name":"accessControlLists"},{"name":"accessPolicies"},{"name":"accounts"},{"name":"acls"},{"name":"actionBatches"},{"name":"adaptivePolicy"},{"name":"addresses"},{"name":"admins"},{"name":"airMarshal"},{"name":"alertTypes"},{"name":"alerts"},{"name":"alternateManagementInterface"},{"name":"analytics"},{"name":"api"},{"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":"autoLocate"},{"name":"autoRf"},{"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":"channels"},{"name":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clients"},{"name":"cloudMonitoring"},{"name":"commands"},{"name":"communicationPlans"},{"name":"compliance"},{"name":"configTemplates"},{"name":"configurationChanges"},{"name":"configure"},{"name":"configuredDevices"},{"name":"connectionStats"},{"name":"connections"},{"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":"esims"},{"name":"ethernet"},{"name":"eventTypes"},{"name":"events"},{"name":"exportEvents"},{"name":"failedConnections"},{"name":"failover"},{"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":"jobs"},{"name":"keys"},{"name":"l2"},{"name":"l3"},{"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":"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":"ratePlans"},{"name":"readings"},{"name":"recent"},{"name":"redundancy"},{"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":"serviceProviders"},{"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":"swap"},{"name":"swaps"},{"name":"switches"},{"name":"syslogServers"},{"name":"system"},{"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":"utilization"},{"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":"wirelessControllers"},{"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":"Returns historical health alert overviews","operationId":"getOrganizationAssuranceAlertsOverviewHistorical","parameters":[{"name":"organizationId","in":"path","description":"Organization ID","schema":{"type":"string"},"required":true},{"name":"segmentDuration","in":"query","required":true,"description":"Amount of time in seconds for each segment in the returned dataset","schema":{"type":"integer"}},{"name":"networkId","in":"query","description":"Optional parameter to filter alerts overview by network ids.","schema":{"type":"string"}},{"name":"severity","in":"query","description":"Optional parameter to filter alerts overview by severity type.","schema":{"type":"string"}},{"name":"types","in":"query","description":"Optional parameter to filter by alert type.","schema":{"type":"array","items":{"type":"string","enum":["aaa_not_enabled","afc_height_empty","afc_status_bad","all_auto_vpn_peers_down","ap_noauth","arp_failure","asymmetry","auto_vpn_peer_down","bad_connectivity","bad_gateway","bad_ip6conf","bad_ipconf","bad_vlanconf","ccd","cellular_failover","cloud_archive_alert","collisions_errors","config","config_bad_fetch","config_error","config_stale","console_error_authentication","console_error_authorization","console_error_timeout","country_mismatch","crc_errors","crc_errors_error","crc_errors_warning","dashboard_config_generation_failure","detected_country_mismatch","device_access_issue","device_config_failure","device_no_space","device_reporting","dfs_event_pattern","disassociation","dns_down","dom_stats_alert","door_tamper","dormant","eapol_test_failed","error_enable_password","ethernet_negotiation_failure","fan_down","firewall","firmware_version","frags_errors","high_cpu_mx","high_interference","high_memory_mx","http_acl_ipv6_conflict","insecure_sm_networks_disabled_enrollment_auth_alert","insight_web_app","insight_web_app_alert","invalid_config","ip_conflict","isp_issue_local_branch","jabbers_errors","l3_dynamic_routes_overflow","l3_hosts_overflow","line_vty_conflict","line_vty_error","low_power","mac_flap_alert","manual_config_fix_required","manual_country_mismatch","mars_read_only_ap_unreachable","meraki_shelluser_conflict","meraki_tdluser_conflict","meraki_user_conflict","mg_safe_mode","missing_config_options","missized_errors","mmc_issue","monitoring_stack_error","monitoring_unsupported_version","mps_down","netconf_abnormal","netconf_acl_ipv6_conflict","netconf_error_authentication","netconf_error_timeout","no_enough_vty_num","no_telemetry","node_check","not_supported_compression_algorithm","not_supported_hostkey_algorithm","not_supported_kex_algorithm","not_supported_mac_algorithm","not_supported_publickey_algorithm","not_supported_ssh_algorithm","ntp_issue","odd_upstream_gateway","openroaming_firmware_incompatible","over_recommended_site_to_site_vpn_tunnels","pcc_apns_check_cert","pcc_apns_expired","pcc_apns_expires_soon","pcc_duplicate_device_identifier","pcc_duplicate_imei","pcc_empty_device_identifier","pcc_empty_imei","pcc_self_signed_scep_expired","pcc_self_signed_scep_expires_soon","poe_denied","poe_overload","probe_cable_unknown","radar_detection","reboot_count","reboot_count_no_xmit_mon","reboot_count_panic","reg_dom_mismatch","rps_backup","rps_down","secure_connect_auth_failure","secure_connect_auth_in_progress","secure_connect_auth_timeout","speed_downshift","ssh_error_authentication","ssh_error_authorization","ssh_error_timeout","ssh_port_rotary_conflict","stack_misconfigured","stack_not_configured","start_monitoring_provisioning","sticky_client","stp_bpdu_conflict","stp_bpduguard_active","stp_loopguard_active","stp_rootguard_active","stp_tcn_error","stp_tcn_errors","stp_tcn_warning","switch_not_setup_as_stack","switch_required_vlans_missing","temperature_cable_disconnect","thousand_eyes_application_alert","traffic_shaping_rule_saturation","udld_err_n_mismatch","udld_err_tx_rx_loop","udld_err_unidir","unknown_config_options","unreachable","unseen","uplink_saturation","using_mtun_http","vlan_disconnect","vlan_mismatch","vlan_prefix_starvation","vmx_incompatible_firmware","voip_jitter","voip_mos","voip_packet_loss","vpn_backhaul","vpn_outage","vrrp_failover","wan_latency","wan_packet_loss","wan_status","wan_usage","water_cable_disconnect","water_usb_connect","wlc_add_standby","wlc_ap_limit","wlc_ap_onboard","wlc_ha_active_recovery","wlc_ha_fail_over_past_day","wlc_ha_standby_offline","wlc_ha_standby_recovery","wlc_interface_errors","wpa3_warning","wrong_console_credentials","yang_authz_conflict","yang_process_abnormal"]}}},{"name":"tsStart","in":"query","required":true,"description":"Parameter to define starting timestamp of historical totals","schema":{"type":"string","format":"date-time"}},{"name":"tsEnd","in":"query","description":"Optional parameter to filter by end timestamp defaults to the current time","schema":{"type":"string","format":"date-time"}},{"name":"category","in":"query","description":"Optional parameter to filter by category.","schema":{"type":"string","enum":["configuration","connectivity","device_health","insights"]}},{"name":"serials","in":"query","description":"Optional parameter to filter by primary device serial","schema":{"type":"array","items":{"type":"string"}}},{"name":"deviceTypes","in":"query","description":"Optional parameter to filter by device types","schema":{"type":"array","items":{"type":"string","enum":["Catalyst AP","Catalyst Controller","Catalyst Switch","MCG","MG","MR","MS","MT","MV","MX","VMX","WLC","Z"]}}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"segmentStart":{"type":"string","format":"date-time","description":"Starting datetime of the segment in iso8601 format"},"totals":{"type":"object","properties":{"informational":{"type":"integer","description":"Informational Severity Count"},"warning":{"type":"integer","description":"Warning Severity Count"},"critical":{"type":"integer","description":"Critical Severity Count"}},"description":"Totals by Severity"},"byAlertType":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Alert Type"},"informational":{"type":"integer","description":"Informational Severity Count"},"warning":{"type":"integer","description":"Warning Severity Count"},"critical":{"type":"integer","description":"Critical Severity Count"}}},"description":"Totals by Type"}},"required":["segmentStart","totals","byAlertType"]},"description":"Historical Severity Counts"},"meta":{"type":"object","properties":{"counts":{"type":"object","properties":{"items":{"type":"integer","description":"Total Segments"}},"required":["items"],"description":"Counts"}},"required":["counts"],"description":"Metadata about the response"}},"required":["items","meta"]},"example":{"items":[{"segmentStart":"2018-02-11T00:00:00Z","totals":{"informational":1,"warning":1,"critical":1},"byAlertType":[{"type":"vlan_mismatch","informational":1,"warning":1,"critical":1}]}],"meta":{"counts":{"items":4}}}}}}},"summary":"Returns historical health alert overviews","tags":["organizations","monitor","alerts","overview","historical"],"__originalOperationId":"getOrganizationAssuranceAlertsOverviewHistorical","security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"method":"get","path":"/organizations/{organizationId}/assurance/alerts/overview/historical","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\norganization_id = '549236'\nsegment_duration = 0\nts_start = ''\n\nresponse = dashboard.organizations.getOrganizationAssuranceAlertsOverviewHistorical(\n organization_id, segment_duration, ts_start\n)\n\nprint(response)","highlight":"python"}}}}