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

AggregateReports → Get aggregate report records

AI-generated

Summary

Retrieve aggregate DMARC report records for a specified account and domain, optionally filtering by various report criteria and handling pagination.

Inputs

  • account_id (required) — The ID of the account to retrieve aggregate report records from.
  • domain_id (required) — The ID of the domain within the account for which to fetch aggregate report records.
  • returnAll — Whether to retrieve all available records (true) or only a single page of results (false).
  • additionalFields — Optional filters and query parameters to refine the search, including date ranges, reporter name, IP address details, policy status, SPF and DKIM alignment/results, DMARC compliance status, pagination (page and per), and others.
  • options — Additional request options such as custom headers, query filters, batching controls, debugging output, pagination configuration (mode, page parameter names, cursor handling, max pages, etc.), and request timeouts.

Output shape

a list of aggregate report records matching the specified account, domain, and optional filters

Supports optional full pagination if 'returnAll' is true and pagination settings are configured; otherwise returns a single page of results. Output may include fetched record fields as returned by the API, optionally augmented by debug information if enabled.

Links

Discussion