Supported Formats

JSON

Errors

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

Examples

{
    "data": {
        "abc.com": {
            "total_spam_ratio": 0.0,
            "domain_reputation": "HIGH",
            "total_spf_success": 43.0,
            "total_dkim_success": 43.0,
            "total_dmarc_success": 35.703,
            "total_inbound_encryption": 43.0,
            "total_records": 43,
            "delivery_errors": 0.0,
            "ip_reputations": {
                "counts": {},
                "percentages": {}
            },
            "average_spam_ratio": 0.0,
            "average_spf_success": 100.0,
            "average_dkim_success": 100.0,
            "average_dmarc_success": 83.0,
            "average_inbound_encryption": 100.0
        },
        "xyz.com": {
            "error_message": "The caller does not have permission"
        },
        "example.org": {
            "total_spam_ratio": 0.20600000000000002,
            "domain_reputation": "HIGH",
            "total_spf_success": 79.0,
            "total_dkim_success": 79.0,
            "total_dmarc_success": 1.338,
            "total_inbound_encryption": 79.0,
            "total_records": 79,
            "delivery_errors": 0.0,
            "ip_reputations": {
                "counts": {
                    "BAD": 363,
                    "LOW": 448,
                    "MEDIUM": 1747,
                    "HIGH": 2387
                },
                "percentages": {
                    "BAD": 7.3,
                    "LOW": 9.1,
                    "MEDIUM": 35.3,
                    "HIGH": 48.3
                }
            },
            "average_spam_ratio": 0.3,
            "average_spf_success": 100.0,
            "average_dkim_success": 100.0,
            "average_dmarc_success": 1.7,
            "average_inbound_encryption": 100.0
        }
    }
}

Params

Param name Description
email
required

Email address of Postmaster Account

Validations:

  • Must be a String