API Guide

Get SNDS Report

Retrieves cached SNDS data for a given SNDS key and over a specified time period. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Note: When either the complaintSamples or trapSamples fields are non-zero, you may call the Get Sample API to retrieve cached sample data.

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

Endpoint URL:

https://api.250ok.com/api/1.0/reputationinformant/snds/report

Sample Output:

[
    {
        "id"               : "1",
        "date"             : "2015-06-01",
        "ip"               : "1.2.3.4",
        "rdns"             : "foo.bar.baz",
        "rcpt"             : "268",
        "data"             : "262",
        "bounces"          : "6",
        "complaints"       : "0",
        "traps"            : "0",
        "complaintSamples" : "0"
    },
    {
        "id"               : "1",
        "date"             : "2015-06-01",
        "ip"               : "3.4.5.6",
        "rdns"             : "qux.bar.baz",
        "rcpt"             : "290",
        "data"             : "285",
        "bounces"          : "5",
        "complaints"       : "0",
        "traps"            : "0",
        "complaintSamples" : "0"
    }
]

Parameters

Parameter Description Acceptable Values Required
id SNDS registration ID. Integer Y
startdate Date on which to start looking for data, in Y-m-d format; defaults to 30 days ago. String N
enddate Date on which to stop looking for data, in Y-m-d format; defaults to today. String N

Error Responses

Description Code Cause
You must provide a numeric SNDS ID. 400 The SNDS key was missing or not an integer value.
You must provide a startdate in the format Y-m-d. 400 You supplied a startdate but it was in the wrong format.
You must provide an enddate in the format Y-m-d. 400 You supplied an enddate but it was in the wrong format.
Bad or missing API key. 401 The X-API-KEY header was missing or contained an unrecognized/invalid key.
No results found. 404 The report parameters were correct but no results were returned.