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 all the details of an aggregate report

AI-generated

Summary

Retrieve detailed information for a specific aggregate report identified by account ID, domain ID, and report ID, optionally handling pagination and custom request parameters.

Inputs

  • account_id (required) — The account identifier to specify the scope of the aggregate report.
  • domain_id (required) — The domain identifier under the specified account.
  • id (required) — The unique identifier of the aggregate report to retrieve.
  • returnAll — Enable to fetch all pages of results or disable to retrieve a single page only.
  • options — Collection of additional request customizations including custom JSON body, HTTP headers, query filters, batching settings, debug mode, pagination configuration, and request timeout.

Output shape

a single detailed aggregate report object, potentially paginated according to parameters.

If pagination is enabled and multiple pages are fetched, the node combines results across pages. Activating debug mode adds a 'debug' entry with request details for troubleshooting. Custom parameters in 'options' override standard request fields.

Examples

Example 1: Get a single aggregate report detail

Set 'account_id', 'domain_id', and 'id' to target the report; disable 'returnAll' to fetch only one page.

Example 2: Fetch all pages of a large aggregate report

Set 'returnAll' to true and configure pagination options such as mode, page size, and max pages in 'options' to control retrieval.

Links

Discussion