API Guide







Item-Level Detail

The Item-Level Detail endpoint provides information for each individual message collected by 250ok Reputation. 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/detail

Sample Output:

[
    {
        "id": "asdf1234",
        "date": "2015-03-22 08:21:07",
        "subject": "Welcome to 250ok!",
        "vintage": "grey",
        "bio_mx_date": 1424390533,
        "fromaddress": "bounces@250ok.com",
        "fromaddress5322": "support@250ok.com",
        "friendlyname": "Support at 250ok",
        "fromdomain": "250ok.com",
        "fromdomain5322": "250ok.com",
        "replytodomain": "250ok.com",
        "ip": "127.0.0.1",
        "reversedns": "mx.250ok.com",
        "country": "US",
        "dkimdomain": "250ok.com",
        "dkim": "pass",
        "spfdomain": "250ok.com",
        "spf": "pass",
        "links": "",
        "images": "",
    }
]
                

Parameters

Parameter Description Acceptable Values Required
id The reputation profile ID Integer Y
type Spam trap or phishing detail. traps, phishing Y
startdate Includes trap hits detected after the specified date (or 24-hour UTC datetime). If unspecified, will default to 7 days prior. yyyy-mm-dd
or
yyyy-mm-dd hh:ii:ss
N
enddate Includes trap hits detected before the specified date (or 24-hour UTC datetime). If unspecified, will default to the current date. yyyy-mm-dd
or
yyyy-mm-dd hh:ii:ss
N
ip Show items sent from the specified IP address String N
subject Show items containing the specified subject String N
fromdomain Show items containing the specified domain String N
fromaddress Show items containing the specified sender address String N
includeimageslinks Include detected images and links found in the message body in the result. Default is no. 0, 1 N

Error Responses

Description Code Cause
You must specify a profile ID. 404 A profile ID was not detected in the request.
Profile does not exist. 404 We couldn't find a profile matching the specified ID.
You must specify a valid type. 404 You did not specify either traps or phishing as the type of results desired.
Invalid start date format. 404 The start date provided was submitted in an invalid format
Invalid end date format. 404 The end date provided was submitted in an invalid format
No results found. 404 We couldn't find any results matching your criteria.