API endpoint

The root endpoint of the production API in the Europe (Frankfurt) region is the following:

<https://api.dmarced.eu/v1>

Authentication

To make requests to the dmarced API on behalf of your team, authenticate your requests following the Basic authentication scheme using your team id (prefixed tm_) as the username and your team secret (prefixed sk_) as the password.

Models

Available DMARC aggregate metrics (11)

• reportedEmailCount

  Total number of emails reported

• acceptedEmailCount

  Number of emails that were accepted by the recipient provider

• quarantinedEmailCount

  Number of emails that were quarantined by the recipient provider

• rejectedEmailCount

  Number of emails that were rejected by the recipient provider

• dmarcCompliantEmailCount

  Number of emails that were compliant with DMARC (SPF or DKIM aligned)

• spfAlignedEmailCount

  Number of emails that were SPF aligned

• dkimAlignedEmailCount

  Number of emails that were DKIM aligned

• ptrConfirmedEmailCount

  Number of emails from a source with a forward-confirmed PTR record

• dmarcReportCount

  Number of DMARC aggregate reports from which the metrics are sourced

• sourceAddressCount

  Number of unique source IP addresses

• sourceLabelCount

  Number of unique source labels, i.e. source IP address or source domain name, if a forward-confirmed PTR record exists