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