Huntress icon

Huntress

Interact with Huntress API

Actions86

SummaryReports → List Summary Reports

AI-generated

Summary

Retrieve a list of summary reports from the Huntress API with optional filtering, sorting, and pagination.

Inputs

  • returnAll — Choose whether to return all summary reports or only a single page of results.
  • limit — Maximum number of reports to return per request when pagination is enabled (default 10; range 1-500).
  • page_token — Token to request the next page in paginated results.
  • sort_field — Field to sort the results by (id, created_at, or updated_at); defaults to id.
  • sort_direction — Direction of sorting, ascending or descending; defaults to descending.
  • period_min — ISO-8601 formatted start date to filter reports within a period.
  • period_max — ISO-8601 formatted end date to filter reports within a period.
  • organization_id — Filter reports by a specific Huntress organization ID.
  • type — Filter by report type, e.g. monthly_summary, quarterly_summary, or yearly_summary (default monthly_summary).
  • options — Additional options including custom request body JSON, custom HTTP headers, query filters, batching controls, debug flag, pagination settings, and request timeout.

Output shape

a list of summary report objects returned by the Huntress API endpoint

Supports fetching either a single page of results or all available pages per user configuration. Pagination can use offset, cursor, or next URL modes. Debug information about the API request can be included if enabled.

Links

Discussion