Mta sts reports
List, Search and Paginate the MTA STS Reports. Plus get all the details of an individual Aggregat Report.

Supported Formats

JSON
>>>

GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/mta_sts_reports.json
List, Search and Paginate MTA Reports

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
404 Not Found
500 Server crashed for some reason

Examples

{
  "reports": [
    {
      "id": 1,
      "domain_id": 1,
      "raw_json": "",
      "organization_name":  "Google Inc.", 
      "start_datetime":  "2019-02-10T00:00:00.000Z", 
      "end_datetime":  "2019-02-10T23:59:59.000Z", 
      "contact_info":  "smtp-tls-reporting@google.com", 
      "report_id":  "2020-02-05T00:00:00Z_webheat.com", 
      "policy_type":  "sts", 
      "policy_string":  '["version: STSv1", "mode: testing", "mx: mx1.eu.mailhop.org ", "max_age: 386000"]', 
      "policy_domain":  "webheat.com", 
      "policy_host":  " ",
      "total_successful_session_count":  "10",
      "total_failure_session_count":  "10",
      "report_email_message_id":  "CAMxgm9Ehr85xOLJHtDe94GpLW03co1yo-GU=FfcZkeG0bzS+qw@mail.gmail.com",
    },
    {
      "id": 2,
      "domain_id": 1,
      "raw_json": "",
      "organization_name":  "Google Inc.", 
      "start_datetime":  "2019-02-10T00:00:00.000Z", 
      "end_datetime":  "2019-02-10T23:59:59.000Z", 
      "contact_info":  "smtp-tls-reporting@google.com", 
      "report_id":  "2020-02-05T00:00:00Z_webheat.com", 
      "policy_type":  "sts", 
      "policy_string":  '["version: STSv1", "mode: testing", "mx: mx1.eu.mailhop.org ", "max_age: 386000"]', 
      "policy_domain":  "webheat.com", 
      "policy_host":  " ",
      "total_successful_session_count":  "10",
      "total_failure_session_count":  "10",
      "report_email_message_id":  "CAMxgm9Ehr85xOLJHtDe94GpLW03co1yo-GU=FfcZkeG0bzS+qw@mail.gmail.com",
    },
    {
      "id": 3,
      "domain_id": 1,
      "raw_json": "",
      "organization_name":  "Google Inc.", 
      "start_datetime":  "2019-02-10T00:00:00.000Z", 
      "end_datetime":  "2019-02-10T23:59:59.000Z", 
      "contact_info":  "smtp-tls-reporting@google.com", 
      "report_id":  "2020-02-05T00:00:00Z_webheat.com", 
      "policy_type":  "sts", 
      "policy_string":  '["version: STSv1", "mode: testing", "mx: mx1.eu.mailhop.org ", "max_age: 386000"]', 
      "policy_domain":  "webheat.com", 
      "policy_host":  " ",
      "total_successful_session_count":  "10",
      "total_failure_session_count":  "10",
      "report_email_message_id":  "CAMxgm9Ehr85xOLJHtDe94GpLW03co1yo-GU=FfcZkeG0bzS+qw@mail.gmail.com",
    }
  ],
  "meta": {
    "total_reports": 3,
    "current_page": 1,
    "per_page": 25,
    "total_pages": 2
  }
}

Params

Param name Description
q
optional

Params for Ransack Search

Validations:

  • Must be a Hash
q[start_datetime_gteq]
optional

Search by date begin start

Validations:

  • Must be a String
q[start_datetime_lteq]
optional

Search by date begin end

Validations:

  • Must be a String
q[organization_name_eq]
optional

Search by for orgnization name

Validations:

  • Must be a String
q[report_id_eq]
optional

Search by report id

Validations:

  • Must be a String
q[policy_type_eq]
optional

Search by policy type

Validations:

  • Must be a String
q[policy_host_eq]
optional

Search by Policy host

Validations:

  • Must be a String
page
optional

Page Number

Validations:

  • Must be a String
per
optional

Entries per page.

Validations:

  • Must be a String
>>>

GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/mta_sts_reports/mta_failure_details.json
List, Search and Paginate MTA Reports

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
404 Not Found
500 Server crashed for some reason

Examples

{
  "failure-details": [
    { "id": 1,
      "result_type": "certificate-host-mismatch",
      "sending_mta_ip": "209.85.128.70",
      "receiving_ip": "52.29.118.68",
      "receiving_mx_hostname": "mx1.eu.mailhop.org",
      "failed_session_count": 1,
      "ip_address": {
        "id": 2,
        "sane_source_ip": "10.10.10.10",
        "blacklisted": null,
        "ptr": null,
        "country": "ro",
        "created_at": "2020-01-16T09:37:38.309Z",
        "updated_at": "2020-01-16T09:37:38.323Z"
      }
    },
    { "id": 2,
      "result_type": "certificate-host-mismatch",
      "sending_mta_ip": "209.85.221.70",
      "receiving_ip": "52.29.118.68",
      "receiving_mx_hostname": "mx1.eu.mailhop.org",
      "failed_session_count": 1,
      "ip_address": {
        "id": 2,
        "sane_source_ip": "10.10.10.10",
        "blacklisted": null,
        "ptr": null,
        "country": "ro",
        "created_at": "2020-01-16T09:37:38.309Z",
        "updated_at": "2020-01-16T09:37:38.323Z"
      }
    },
    { "id": 3,
      "result_type": "certificate-host-mismatch",
      "sending_mta_ip": "209.85.221.71",
      "receiving_ip": "52.29.162.96",
      "receiving_mx_hostname": "mx1.eu.mailhop.org",
      "failed_session_count": 3,
      "ip_address": {
        "id": 2,
        "sane_source_ip": "10.10.10.10",
        "blacklisted": null,
        "ptr": null,
        "country": "ro",
        "created_at": "2020-01-16T09:37:38.309Z",
        "updated_at": "2020-01-16T09:37:38.323Z"
      }
    }
  ]
}

Params

Param name Description
q
optional

Params for Ransack Search

Validations:

  • Must be a Hash
q[sending_mta_ip_address_source_ip_eq]
optional

Search by sending source ip

Validations:

  • Must be a String
q[receiving_ip_address_source_ip_eq]
optional

Search by receiving source ip

Validations:

  • Must be a String
q[result_type_eq]
optional

Search byresult type

Validations:

  • Must be a String
q[receiving_mx_hostname_eq]
optional

Search by receiving mx host name

Validations:

  • Must be a String
page
optional

Page Number

Validations:

  • Must be a String
per
optional

Entries per page.

Validations:

  • Must be a String
>>>

GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/mta_sts_reports/:id.json
Get all the details of a MTA Report

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
404 Not Found
500 Server crashed for some reason

Examples

{
  "id": 1,
  "domain_id": 1,
  "organization-name": "Google Inc.",
  "start-datetime": "2020-02-05T00:00:00Z",
  "end-datetime": "2020-02-05T23:59:59Z",
  "contact-info": "smtp-tls-reporting@google.com",
  "report-id": "2020-02-05T00:00:00Z_webheat.com",
  "policy-type": "sts",
  "policy-string": [
    "version: STSv1",
    "mode: testing",
    "mx: mx1.eu.mailhop.org ",
    "max_age: 386000"
  ],
  "policy-domain": "webheat.com",
  "total-successful-session-count": 0,
  "total-failure-session-count": 7,
  "failure-details": [
    { "id": 1,
      "result_type": "certificate-host-mismatch",
      "sending_mta_ip": "209.85.128.70",
      "receiving_ip": "52.29.118.68",
      "receiving_mx_hostname": "mx1.eu.mailhop.org",
      "failed_session_count": 1,
      "ip_address": {
        "id": 2,
        "sane_source_ip": "10.10.10.10",
        "blacklisted": null,
        "ptr": null,
        "country": "ro",
        "created_at": "2020-01-16T09:37:38.309Z",
        "updated_at": "2020-01-16T09:37:38.323Z"
      }
    },
    { "id": 2,
      "result_type": "certificate-host-mismatch",
      "sending_mta_ip": "209.85.221.70",
      "receiving_ip": "52.29.118.68",
      "receiving_mx_hostname": "mx1.eu.mailhop.org",
      "failed_session_count": 1,
      "ip_address": {
        "id": 2,
        "sane_source_ip": "10.10.10.10",
        "blacklisted": null,
        "ptr": null,
        "country": "ro",
        "created_at": "2020-01-16T09:37:38.309Z",
        "updated_at": "2020-01-16T09:37:38.323Z"
      }
    },
    { "id": 3,
      "result_type": "certificate-host-mismatch",
      "sending_mta_ip": "209.85.221.71",
      "receiving_ip": "52.29.162.96",
      "receiving_mx_hostname": "mx1.eu.mailhop.org",
      "failed_session_count": 3,
      "ip_address": {
        "id": 2,
        "sane_source_ip": "10.10.10.10",
        "blacklisted": null,
        "ptr": null,
        "country": "ro",
        "created_at": "2020-01-16T09:37:38.309Z",
        "updated_at": "2020-01-16T09:37:38.323Z"
      }
    }
  ]
}