API Guide

Get Spam Report

This API allows you retrieve a full spam filter test for a particular Design test. 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/designinformant/spam

Sample Output:

[
     {
          "name": "aolonlinespam",
          "longname": "AOL Mail",
          "platform": "Desktop spam",
          "longplatform": "Desktop-based spam filters",
          "description": "The filter offered as part of AOL's mail service. Recipients can aid delivery by adding the sender's email address to their address book. That's not been done here, so this represents a more pessimistic spam scoring.",
          "foundinspam": "0",
          "spamscore": "0.00000",
          "spamheaders": "a:0:{}",
          "status": "complete"
     },
     {
          "name": "gmailnewspam",
          "longname": "Gmail",
          "platform": "Desktop spam",
          "longplatform": "Desktop-based spam filters",
          "description": "The filter offered as part of Google's Gmail service. Recipients can aid delivery by adding the sender's email address to their address book. That's not been done here, so this represents a more pessimistic spam scoring.",
          "foundinspam": "1",
          "spamscore": "0.00000",
          "spamheaders": "a:0:{}",
          "status": "complete"
     },
]
                    

Parameters

Parameter Description Acceptable Values Required
id Retrieve a spam report by test ID. Integer Y

Error Responses

Description Code Cause
No results found. 404 We couldn't find any results matching your criteria.
Test ID must be specified. 404 The unique identifier of the test is missing or invalid.
Invalid Test ID. 404 The test ID must be numeric.
NULL 401 Your API key does not have sufficient permission to access this endpoint.