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 stats of domain

AI-generated

Summary

Retrieve aggregate DMARC report statistics for a specified domain within a given date range.

Inputs

  • account_id (required) — The account ID to identify the user account.
  • domain_id (required) — The domain ID for which to retrieve aggregate report statistics.
  • q[start_date] (required) — The start date for the statistics query in YYYY-MM-DD format.
  • q[end_date] (required) — The end date for the statistics query in YYYY-MM-DD format.
  • returnAll — Whether to return all result pages or only the first page.
  • additionalFields.filter — Preset filter for time range such as last_7_days, last_10_days, last_15_days, or last_30_days.
  • options.customBody — Optional custom JSON body to merge with the request body, overriding other fields.
  • options.headerFilters — Custom HTTP headers to include in the request.
  • options.queryFilters — Additional query-string filters to add to the request.
  • options.batching — Batch size and interval settings for requests.
  • options.debug — Enable to include request details for debugging purposes.
  • options.pagination — Settings to configure pagination mode, parameters, and limits.
  • options.timeout — Maximum time in milliseconds to wait for the server response.

Output shape

a JSON object containing aggregate DMARC report statistics for the domain and date range, potentially paginated

Supports pagination when 'returnAll' is true, configurable via pagination options. Debug information is included in the output if enabled.

Examples

Example 1: Retrieve aggregate report stats for a domain with a specified date range

Provide 'account_id', 'domain_id', 'q[start_date]', and 'q[end_date]' with required formats; optionally set 'returnAll' to true to fetch all pages and enable 'debug' for troubleshooting.

Links

Discussion