API Guide







Get SignalSpam Report

Retrieves cached SignalSpam data for a given SignalSpam key and over a specified time period. 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/signalspam/report

Sample Output:

[
    {
        "date"       : "2015-09-30",
        "provider"   : "provider-name",
        "ip"         : "1.2.3.4",
        "rnds"       : "foo.bar.baz",
        "complaints" : "0"
    },
    {
        "date"       : "2015-09-30",
        "provider"   : "other-provider-name",
        "ip"         : "5.6.7.8",
        "rnds"       : "qux.bar.baz",
        "complaints" : "0"
    }
]

Parameters

Parameter Description Acceptable Values Required
id SignalSpam 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 SignalSpam ID. 400 The SignalSpam 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.