latestSwagger 2.02026-08-109450223.9 KB

94acb422c07d

Summary Reports

List Summary Reports

Shows Summary Reports associated with your account.

Note: This endpoint will also return a pagination key on the root level.
Please refer to the pagination section within our docs for more information.

get/v1/reports

Query parameters

limitinteger

Max number of resources returned in a paged collection. Defaults to 10, with a minimum of 1 and maximum 500.

page_tokenstring

Token used to request the next page in paginated results. Defaults to 'null'

sort_field'id' | 'created_at' | 'updated_at'

Field to sort by. Defaults to 'id'.

sort_direction'asc' | 'desc'

Sort direction. Defaults to 'desc'.

period_minstring

Filter by an ISO-8601 formatted date string that represents the lower bound of the search range for the period date.

period_maxstring

Filter by an ISO-8601 formatted date string that represents the upper bound of the search range for the period date.

organization_idinteger

Filter by organization ID within Huntress account

type'monthly_summary' | 'quarterly_summary' | 'yearly_summary'

Filter by report type. One of monthly_summary, quarterly_summary, yearly_summary

Response

List Summary Reports

Example response

{
  "reports": [
    {
      "id": 1,
      "agents_count": 2,
      "analyst_name": "Jane Doe",
      "analyst_note": "Everything is awesome! Thanks for using Huntress.",
      "analyst_threats": [
        "Ransomware",
        "Dridex",
        "Jupyter"
      ],
      "analyst_title": "Senior Security Analyst",
      "created_at": "2022-03-01T20:56:15Z",
      "external_ips_count": 3,
      "external_ports_count": 12,
      "external_services": [
        {
          "name": "SSH",
          "risky": true
        },
        {
          "name": "HTTP",
          "risky": false
        }
      ],
      "firewall_enabled_count": 10,
      "global_threats_note": "World peace! No threats to see here.",
      "incident_indicator_counts": {
        "managed_av": 0
      },
      "incident_log": [],
      "incident_product_counts": {
        "edr": 16,
        "itdr": 0,
        "siem": 0
      },
      "incident_severity_counts": {
        "low": 16
      },
      "incidents_reported": 16,
      "incidents_resolved": 1,
      "itdr_billable_identity_count": 50,
      "itdr_non_billable_identity_count": 10,
      "itdr_license_distribution": {
        "Microsoft 365 E3": 25,
        "Microsoft 365 E5": 15,
        "Other": 10
      },
      "itdr_usage_locations": [
        "US",
        "CA",
        "GB",
        "DE"
      ],
      "organization_id": 7,
      "period": "2022-02-01...2022-03-02",
      "powerful_application_count": 3,
      "ransomware_note": "No ransoms to report, all is well.",
      "risky_services_count": 1,
      "rogue_app_incidents": [
        {
          "id": 12345678,
          "severity": "critical",
          "sent_at": "2026-04-17T12:34:56Z",
          "event_summary": "Suspicious login detected from unusual location.",
          "body": "A suspicious login was detected from an unusual location.",
          "remediations": [
            {
              "type": "Remediations::SessionRevocation",
              "subtype": "containment"
            }
          ]
        }
      ],
      "shadow_workflow_incidents": [
        {
          "id": 12345678,
          "severity": "critical",
          "sent_at": "2026-04-17T12:34:56Z",
          "event_summary": "Suspicious login detected from unusual location.",
          "body": "A suspicious login was detected from an unusual location.",
          "remediations": [
            {
              "type": "Remediations::SessionRevocation",
              "subtype": "containment"
            }
          ]
        }
      ],
      "top_incident_av_threats": [
        "some_threat",
        "another_threat",
        "threats_threats_threats"
      ],
      "top_incident_hosts": [
        "some_host",
        "another_host",
        "hosts_hosts_hosts"
      ],
      "total_entities": 2,
      "type": "monthly_summary",
      "unwanted_access_incidents": [
        {
          "id": 12345678,
          "severity": "critical",
          "sent_at": "2026-04-17T12:34:56Z",
          "event_summary": "Suspicious login detected from unusual location.",
          "body": "A suspicious login was detected from an unusual location.",
          "remediations": [
            {
              "type": "Remediations::SessionRevocation",
              "subtype": "containment"
            }
          ]
        }
      ],
      "updated_at": "2022-03-01T20:56:15Z",
      "url": "https://huntress.io/rails/active_storage/blobs/redirect/uuid.pdf?disposition=download",
      "windows_agent_count": 2,
      "weak_application_count": 1,
      "windows_agents": true
    }
  ]
}