API Guide







Get DMARC Authentication Overview

Retrieves all DMARC domains registered with and monitored by a user. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: GET

Endpoint URL:

https://api.250ok.com/api/1.0/reputationinformant/dmarc/authenticationoverview

Sample Output:

{
    "spf": {
        "2016-08-30": {
            "none": 9,
            "neutral": 119,
            "pass": 15305,
            "fail": 2,
            "softfail": 231,
            "temperror": 22,
            "permerror": 1
        }
    },
    "dkim": {
        "2016-08-30": {
            "none": 3,
            "pass": 15389,
            "fail": 29,
            "neutral": 0,
            "policy": 0,
            "temperror": 0,
            "permerror": 2,
            "": 266
        }
    },
    "both": {
        "2016-08-30": {
            "none": {
                "none": 0,
                "pass": 8,
                "fail": 1,
                "neutral": 0,
                "policy": 0,
                "temperror": 0,
                "permerror": 0
            },
            "neutral": {
                "none": 0,
                "pass": 112,
                "fail": 5,
                "neutral": 0,
                "policy": 0,
                "temperror": 0,
                "permerror": 1,
                "": 1
            },
            "pass": {
                "none": 3,
                "pass": 15264,
                "fail": 5,
                "neutral": 0,
                "policy": 0,
                "temperror": 0,
                "permerror": 0,
                "": 33
            },
            "fail": {
                "none": 0,
                "pass": 2,
                "fail": 0,
                "neutral": 0,
                "policy": 0,
                "temperror": 0,
                "permerror": 0
            },
            "softfail": {
                "none": 0,
                "pass": 2,
                "fail": 13,
                "neutral": 0,
                "policy": 0,
                "temperror": 0,
                "permerror": 1,
                "": 215
            },
            "temperror": {
                "none": 0,
                "pass": 0,
                "fail": 5,
                "neutral": 0,
                "policy": 0,
                "temperror": 0,
                "permerror": 0,
                "": 17
            },
            "permerror": {
                "none": 0,
                "pass": 1,
                "fail": 0,
                "neutral": 0,
                "policy": 0,
                "temperror": 0,
                "permerror": 0
            }
        }
    }
}
        

Parameters

Parameter Description Acceptable Values Required
domain Sender domain String Y
startdate Includes trap hits detected after the specified date. If unspecified, will default to 30 days prior. yyyy-mm-dd N
enddate Includes trap hits detected before the specified date. If unspecified, will default to the current date. yyyy-mm-dd N

Error Responses

Description Code Cause
Domain is required. 400 Please specify a domain for the query.
Bad or missing API key. 401 The X-API-KEY header was missing or contained an unrecognized/invalid key.
No results found. 404 There are no DMARC domains registered to the account.