Supported Formats

JSON

Errors

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

Examples

{
  "reports": [
    {
      "id": 1,
      "raw_xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>...",
      "org_name": "google.com",
      "email": "noreply-dmarc-support@google.com",
      "extra_contact_info": "https://support.google.com/a/answer/2466580",
      "report_id": "1627703331531660819",
      "date_begin": "2019-02-10T00:00:00.000Z",
      "date_end": "2019-02-10T23:59:59.000Z",
      "policy_domain": "twlnet.com",
      "dkim_alignment": "s",
      "spf_alignment": "s",
      "domain_policy": "reject",
      "subdomain_policy": "reject",
      "percentage": 100,
      "domain_id": 1,
      "created_at": "2019-10-10T11:47:11.613Z",
      "updated_at": "2019-10-10T11:47:11.613Z",
      "records_count": null,
      "report_email_message_id": null
    },
    {
      "id": 2,
      "raw_xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>...",
      "org_name": "google.com",
      "email": "noreply-dmarc-support@google.com",
      "extra_contact_info": "https://support.google.com/a/answer/2466580",
      "report_id": "949348866075514174",
      "date_begin": "2019-02-12T00:00:00.000Z",
      "date_end": "2019-02-12T23:59:59.000Z",
      "policy_domain": "borschow.com",
      "dkim_alignment": "r",
      "spf_alignment": "r",
      "domain_policy": "reject",
      "subdomain_policy": "reject",
      "percentage": 100,
      "domain_id": 1,
      "created_at": "2019-10-10T11:48:07.386Z",
      "updated_at": "2019-10-10T11:48:07.386Z",
      "records_count": null,
      "report_email_message_id": null
    },
    ...
  ],
  "meta": {
    "total_reports": 5,
    "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[org_name_eq]
optional

Search by Reporter

Validations:

  • Must be a String

q[date_begin_gteq]
optional

Search by date begin, Format: YYYY-MM-DD

Validations:

  • Must be a String

q[date_begin_lteq]
optional

Search by date end, Format: YYYY-MM-DD

Validations:

  • Must be a String

page
optional

Page Number

Validations:

  • Must be a String

per
optional

Entries per page.

Validations:

  • Must be a String