API Guide







Get ISP Health

The ISP Health dashboard shows the deliverability averages and trends to each individual ISP based on community performance. You can return results across all providers, or pass a 'provider' parameter to view a specific provider. 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/inboxinformant/health

Sample Output (without 'provider_id' parameter):

[
  "Global": {
    "AOL": {
      "provider": "AOL",
      "inbox": 68.8,
      "provider_id": 13,
      "inbox_trend": -8.9,
      "spam": 3.7,
      "spam_trend": -1,
      "missing": 27.5,
      "missing_trend": 9.9
    }, ...
  },
  "North America": {
    "ATT": {
      "provider": "ATT",
      "provider_id": 15,
      "inbox": 68.6,
      "inbox_trend": 0.4,
      "spam": 0.7,
      "spam_trend": -3.4,
      "missing": 30.7,
      "missing_trend": 3
    }, ...
]
                

Sample Output (with 'provider_id' parameter):

[
  {
    "provider": "AOL",
    "provider_id": 13,
    "date": "05/08/2017",
    "dow": "Monday",
    "inbox": 77.4,
    "spam": 7.7,
    "missing": 14.9
  }, ...
]
                

Parameters

Parameter Description Acceptable Values Required
provider_id The unique identifier of a specific provider Integer N
startdate Returns items blacklisted on or after the specified date. yyyy-mm-dd N
enddate Returns items blacklisted on or before the specified date. yyyy-mm-dd N

Error Responses

Description Code Cause
Invalid provider ID 404 The unique identifier of the region is invalid
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