Skip to content
ReputeCastReputeCast Docs

Domain, IP and provider health, blocklists, Postmaster, SNDS, DMARC and incidents

GET
/api/v1/workspaces/{workspace}/deliverability
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/deliverability \
  --header 'Authorization: Bearer <token>'

Permission: deliverability:view

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
assets
required
Array<object>
object
asset
required
string
auth
object
bimi
required
string
checkedAt
string format: date-time
dkim
required
string
dmarc
required

Policy (none, quarantine, reject) or missing / invalid

string
returnPath
required
string
spf
required
string
blocklists
required
object
checkedAt
string format: date-time
highImpact
required
boolean
listed
required
integer format: int64
listings
required
Array<string>
sources
required
integer format: int64
via
required
string
Allowed values: hostrepute builtin none
dmarcAligned
number format: double
fallback
object
checkedAt
string format: date-time
highImpact
required
boolean
listed
required
integer format: int64
listings
required
Array<string>
sources
required
integer format: int64
via
required
string
Allowed values: hostrepute builtin none
gmailReputation
string
notMonitored
boolean
provider
string
providerId
string
providerStatus
string
reverseDns
object
matches
required
boolean
ptr
string
status
required
string
role
required
string
Allowed values: sending_domain dedicated_ip
score
integer format: int64
snds
object
filterResult
required
string
trapHits
required
integer format: int64
stale
string format: date-time
tone
required
string
Allowed values: ok warn bad neutral
type
required
string
Allowed values: domain ip
usedBy
required
Array<string>
verdict
string
warmup
object
day
required
integer format: int64
days
required
integer format: int64
blocklists
required
object
assets
required
Array<string>
checkedAt
string format: date-time
clean
required
integer format: int64
interval
required
string
Allowed values: hourly daily
listed
required
integer format: int64
results
required
Array<object>
object
assets
required
Array<string>
delistUrl
string
delisting
string
Allowed values: requested pending delisted denied
delistingAt
string format: date-time
detail
string
impact
required
string
Allowed values: high medium low
listed
required
boolean
listedAssets
required
Array<string>
since
string format: date-time
source
required
string
sources
required
integer format: int64
stale
required
boolean
via
required
string
Allowed values: hostrepute builtin none
checks
required
object
builtinSources
required
integer format: int64
interval
required
string
Allowed values: hourly daily
lastAt
string format: date-time
nextAt
string format: date-time
running
object
answered
required
integer format: int32
assets
required
Array<string>
error
string
finishedAt
string format: date-time
id
required
string
listed
required
integer format: int32
startedAt
required
string format: date-time
status
required
string
Allowed values: running done failed
total
required
integer format: int32
trigger
required
string
Allowed values: schedule manual connect fallback
via
required
string
Allowed values: hostrepute builtin
via
required
string
Allowed values: hostrepute builtin
dmarc
required
object
days
required
integer format: int64
domain
string
messages
required
integer format: int64
passRate
number format: double
policy
string
reports
required
integer format: int64
rua
string
sources
required
Array<object>
object
adapter
string
dkim
required
string
ip
string
known
required
boolean
label
required

Amazon SES, Postal · 203.0.113.25, Unknown · 198.51.100.77

string
messages
required
integer format: int64
providerId
string
result
required
string
Allowed values: pass quarantined rejected fail
spf
required

Aligned, or the raw result: fail, softfail, none…

string
unknown
object
adapter
string
dkim
required
string
ip
string
known
required
boolean
label
required

Amazon SES, Postal · 203.0.113.25, Unknown · 198.51.100.77

string
messages
required
integer format: int64
providerId
string
result
required
string
Allowed values: pass quarantined rejected fail
spf
required

Aligned, or the raw result: fail, softfail, none…

string
via
required
string
Allowed values: hostrepute upload none
hostRepute
required
object
dmarcRua
string
intervalMinutes
required
integer format: int32
lastSyncAt
string format: date-time
sources
required
integer format: int32
status
required
string
Allowed values: not_connected connected revoked expired error
teamName
string
tokenRejectedAt
string format: date-time
unreachable
object
message
required

Couldn’t reach api.hostrepute.com (timeout after 30 s, 3 attempts)

string
since
string format: date-time
incidents
required
object
fromHostRepute
required
boolean
items
required
Array<object>
object
detail
required
string
id
required
string
kind
required
string
links
required
Array<object>
object
id
string
kind
required
string
Allowed values: warmup campaign campaign_report provider provider_events import deliverability
label
required
string
occurredAt
required
string format: date-time
severity
required
string
Allowed values: info ok warn bad
source
required
string
Allowed values: reputecast hostrepute builtin
title
required
string
total
required
integer format: int64
pools
required
Array<object>
object
accountStatus
required
string
adapter
required
string
bounceRate
number format: double
complaintRate
number format: double
dedicatedIpOption
string
gmailIpReputation
string
managedReputation
required
boolean
onlyStream
string
Allowed values: broadcast automation system
provider
required
string
providerId
required
string
region
string
short
required
string
status
required
string
volumeThisMonth
integer format: int64
postmaster
object
dkim
number format: double
dmarc
number format: double
domain
required
string
domainReputation
string
feedbackLoopFlagged
integer format: int64
from
required
string format: date
ipReputation
string
ipReputationPool
string
peak
object
day
required
string format: date
note
string
spamRate
required
number format: double
series
required
Array<object>
object
from
required
string format: date
spamRate
number format: double
to
required
string format: date
spamRate
number format: double
spf
number format: double
stale
required
boolean
tls
number format: double
to
required
string format: date
via
required
string
Allowed values: hostrepute direct
providers
required
Array<object>
object
adapter
required
string
badge
required

Healthy · no enforcement

string
bounce
required
object
label
required

Bounce rate, Complaint rate, Spam complaint rate

string
thresholds
required
string
tone
required
string
Allowed values: ok warn bad
usage
required
number format: double
value
number format: double
complaint
required
object
label
required

Bounce rate, Complaint rate, Spam complaint rate

string
thresholds
required
string
tone
required
string
Allowed values: ok warn bad
usage
required
number format: double
value
number format: double
name
required

Postal (self-hosted)

string
note
object
label
required
string
value
required
string
providerId
required
string
status
required
string
tone
required
string
Allowed values: ok warn bad info neutral
snds
object
complaintRate
number format: double
filterResult
required
string
Allowed values: green yellow red ""
ip
required
string
jmrpReports
required
integer format: int64
messages7d
required
integer format: int64
stale
required
boolean
trapHits
required
integer format: int64
via
required
string
Allowed values: hostrepute direct

Example 

{
  "assets": [
    {
      "blocklists": {
        "via": "hostrepute"
      },
      "fallback": {
        "via": "hostrepute"
      },
      "role": "sending_domain",
      "tone": "ok",
      "type": "domain"
    }
  ],
  "blocklists": {
    "interval": "hourly",
    "results": [
      {
        "delisting": "requested",
        "impact": "high"
      }
    ],
    "via": "hostrepute"
  },
  "checks": {
    "interval": "hourly",
    "running": {
      "status": "running",
      "trigger": "schedule",
      "via": "hostrepute"
    },
    "via": "hostrepute"
  },
  "dmarc": {
    "sources": [
      {
        "result": "pass"
      }
    ],
    "unknown": {
      "result": "pass"
    },
    "via": "hostrepute"
  },
  "hostRepute": {
    "status": "not_connected"
  },
  "incidents": {
    "items": [
      {
        "links": [
          {
            "kind": "warmup"
          }
        ],
        "severity": "info",
        "source": "reputecast"
      }
    ]
  },
  "pools": [
    {
      "onlyStream": "broadcast"
    }
  ],
  "postmaster": {
    "via": "hostrepute"
  },
  "providers": [
    {
      "bounce": {
        "tone": "ok"
      },
      "complaint": {
        "tone": "ok"
      },
      "tone": "ok"
    }
  ],
  "snds": {
    "filterResult": "green",
    "via": "hostrepute"
  }
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0