Huntress icon

Huntress

Interact with Huntress API

Actions86

SummaryReports → Get Summary Report

AI-generated

Summary

Retrieve a specific summary report from the Huntress API by its report ID within your Huntress account.

Inputs

  • id (required) — Numeric ID of the summary report to fetch from the Huntress account.
  • options.customBody — Optional JSON to send as a custom body in the request, deep-merged with other request fields; takes priority over other body fields.
  • options.headerFilters — Optional collection of custom HTTP headers to include in the request, specified as key-value pairs.
  • options.queryFilters — Optional collection of query string filters as key-value pairs to modify the API request.
  • options.batching — Optional batching settings to group multiple input items per batch and delay between batches to prevent rate limiting.
  • options.debug — Optional boolean to include full debug details of the request and response for troubleshooting.
  • options.pagination — Optional pagination settings to handle paged responses if applicable.
  • options.timeout — Optional timeout in milliseconds to wait for the server response before aborting the request (default 300000).

Output shape

a single JSON object representing the summary report associated with the provided report ID

Returns the detailed data for the specified report ID within the authenticated Huntress account. Pagination and batching options apply if multiple input items are processed. Debug information appears in the output if enabled.

Links

Discussion