Reports

Get the DMARC summary

get/domains/{domainId}/reports/summary

Request

  • Base URL: https://api.palisade.email
  • URL: https://api.palisade.email/domains/{domainId}/reports/summary
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

domainIdstring uuid required

Query parameters

period'last_7_days' | 'last_14_days' | 'last_30_days'

Reporting window, ending yesterday. Defaults to last_7_days.

Headers

Palisade-Version'2025-04-30' | 'unstable' required

Response

Success

domain_idstring uuid required

Id of the domain the summary is for.

domainstring required

The domain name the summary is for.

date_fromstring required

First day of the window, YYYY-MM-DD. Clamped to the earliest day the organization's plan retains report history for, so it can be later than the requested period alone implies.

date_tostring required

Last day of the window, YYYY-MM-DD. Always yesterday: aggregate reports arrive a day in arrears, so a window ending today would read as a volume collapse.

volumeinteger required

Total messages reported in the window, across every compliance bucket.

dmarc_pass_pctnumber required

Share of volume that passed DMARC, 0-100, rounded to two decimals, and 0 when the window has no volume. The denominator is volume, so forwarded and uncategorised traffic counts against it - which is why this reads lower than the last_14_days figure.

spf_pass_pctnumber required

Share of volume that passed SPF, 0-100, rounded to two decimals, and 0 when the window has no volume.

dkim_pass_pctnumber required

Share of volume that passed DKIM, 0-100, rounded to two decimals, and 0 when the window has no volume.

dmarc_policystring required

The domain's DMARC policy state, in the same form GET /domains/{id} reports.

monitoring_statusstring required

Monitoring state of the domain, in the same form GET /domains/{id} reports.

open_tasks_countinteger required

Total open and pending tasks, which may exceed the array length.

next_stepstring required

The single action Palisade suggests taking next.

Changes

No recorded changes to this operation across all 1 revision of this API.