Reports

Get report details

Returns a single report with all individual records and geolocation data.

get/api/v1/reports/{id}

Request

  • Base URL: https://api.dmarc-examiner.com
  • URL: https://api.dmarc-examiner.com/api/v1/reports/{id}
  • Auth: API key in header X-API-Key

Path parameters

idstring uuid required

Report UUID.

Response

Report with records

idstring uuid required
domain_idstring uuid required
domain_namestring nullable
external_report_idstring required

Report ID assigned by the reporting organization.

reporter_org_namestring required

Name of the organization that generated the report.

reporter_emailstring email required

Contact email of the reporting organization.

date_range_beginstring date-time required

Start of the reporting period (ISO 8601).

date_range_endstring date-time required

End of the reporting period (ISO 8601).

policy_domainstring required
policy_p'none' | 'quarantine' | 'reject' required

DMARC policy for the domain.

policy_sp'none' | 'quarantine' | 'reject' nullable

DMARC policy for subdomains. Falls back to policy_p when null.

policy_adkim'r' | 's'

DKIM alignment mode (r=relaxed, s=strict).

policy_aspf'r' | 's'

SPF alignment mode (r=relaxed, s=strict).

policy_pctinteger required

Percentage of messages to which the policy applies.

total_recordsinteger required

Total number of email messages in the report.

pass_ratenumber float required

Percentage of messages passing both DKIM and SPF (0-100, 1 decimal).

received_atstring date-time required
processed_atstring date-time nullable
created_atstring date-time required

Example response

{
  "domain_name": "example.com",
  "domain": {
    "name": "example.com"
  },
  "reporter_org_name": "google.com",
  "policy_domain": "example.com",
  "pass_rate": 98.5,
  "records": [
    {
      "source_ip": "209.85.220.41",
      "geo": {
        "country": "United States",
        "country_code": "US",
        "org": "Google LLC",
        "asn": 15169,
        "cidr": "192.0.2.0/24"
      }
    }
  ]
}

Changes

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