DMARC Report icon

DMARC Report

API documentation for DMARC Report v2. Provides endpoints for managing accounts, domains, aggregate reports, forensic (failure) reports, MTA-STS reports, postmaster account records, and account members.

Actions35

ForensicReports → List, search, and paginate failure reports

AI-generated

Summary

List, search, and paginate DMARC forensic failure reports for a specified account and domain, with optional filters and pagination settings.

Inputs

  • account_id (required) — The account id used to specify which account's reports to retrieve.
  • domain_id (required) — The domain id used to specify which domain's forensic reports to retrieve.
  • returnAll — Whether to return all results (multiple pages) or only a single page.
  • additionalFields — Optional filters to refine the search, including date ranges, IP address criteria, delivery result, feedback type, message-specific fields, and pagination parameters like page number and entries per page.
  • options — Additional settings such as custom request body JSON, custom headers, query filters, batching settings, debug flag to include request details in the output, pagination configuration (mode, cursor/path handling, page size, maximum pages, etc.), and request timeout.

Output shape

a paginated list of forensic failure reports

Supports various pagination modes (offset, cursor, or next URL) configured by the user. When 'Return All' is enabled, it retrieves all pages according to pagination settings. Optional debug data can include full request details. Filtering is available through query parameters to narrow the list of reports returned.

Links

Discussion