---
title: "Retrieves security overview information."
method: GET
path: "/api/v1/accounts/{accountId}/securityoverview/{period}"
---

# Retrieves security overview information.

`GET /api/v1/accounts/{accountId}/securityoverview/{period}`

## Request

- Base URL: `https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt`
- URL: `https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt/api/v1/accounts/{accountId}/securityoverview/{period}`
- Auth: API key in header `WatchGuard-API-Key` and HTTP bearer
- TypeScript: <https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/docs/api/v1/accounts/:accountId/securityoverview/:period/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves counters for security overview.

## Path parameters

- `accountId` string, required
- `period` 1 | 7 | 30, required

## Response `200`

OK

- SecurityOverviewCountersResult
  - `total_devices` integer: Total number of devices.
  - `total_unmanaged_devices` integer: Total number of unmanaged devices.
  - `malware` SecurityOverviewAggregatedCounters
    - `total_alerts` integer, nullable: Total number of alerts.
    - `total_executed` integer, nullable: Number of executed instances.
    - `total_data_access` integer, nullable: Number of times data was accessed.
    - `total_external_communications` integer, nullable: Number of external communications.
    - `total_affected_devices` integer, nullable: Number of affected devices.
  - `pups` SecurityOverviewAggregatedCounters
    - `total_alerts` integer, nullable: Total number of alerts.
    - `total_executed` integer, nullable: Number of executed instances.
    - `total_data_access` integer, nullable: Number of times data was accessed.
    - `total_external_communications` integer, nullable: Number of external communications.
    - `total_affected_devices` integer, nullable: Number of affected devices.
  - `exploits` SecurityOverviewAggregatedCounters
    - `total_alerts` integer, nullable: Total number of alerts.
    - `total_executed` integer, nullable: Number of executed instances.
    - `total_data_access` integer, nullable: Number of times data was accessed.
    - `total_external_communications` integer, nullable: Number of external communications.
    - `total_affected_devices` integer, nullable: Number of affected devices.
  - `programs_blocked` ProgramBlockedOverviewCounters
    - `total_programs_blocked` integer, nullable: Number of blocked programs.
  - `threats_by_av_counters` ThreatsByAvOverviewCounters
    - `total_phishing_detected_by_av` integer, nullable: Number of phishing attempts detected by antivirus.
    - `total_tracking_cookies_detected_by_av` integer, nullable: Number of tracking cookies detected by antivirus.
    - `total_devices_blocked_by_av` integer, nullable: Number of devices blocked by antivirus.
    - `total_malware_urls_blocked_by_av` integer, nullable: Number of malware URLs blocked by antivirus.
    - `total_intrusion_attempted_blocked_by_av` integer, nullable: Number of intrusion attempts blocked by antivirus.
    - `total_dangerous_actions_blocked_by_av` integer, nullable: Number of dangerous actions blocked by antivirus.
    - `total_hacking_tools_by_av` integer, nullable: Number of hacking tools detected by antivirus.
    - `total_spyware_by_av` integer, nullable: Number of spyware detected by antivirus.
    - `total_virus_by_av` integer, nullable: Number of virus detected by antivirus.
  - `indicators_of_attack_counters` IndicatorsOfAttackCounters
    - `total_indicators_of_attack` integer, nullable: Number of indicators of attack.
  - `network_attack_counters` NetworkAttackAggregatedCounters
    - `total_alerts` integer, nullable: Number of alerts.
    - `total_affected_devices` integer, nullable: Number of affected devices.

## Other responses

- `400`: BAD REQUEST.
- `403`: ACCESS DENIED.
- `404`: NOT FOUND.
- `405`: METHOD NOT ALLOWED.
- `500`: INTERNAL ERROR.

---

[API](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api.md) - [All operations](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/llms.txt) - [OpenAPI document](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/revisions/1376eee70d39?raw)