Skip to content
ReputeCastReputeCast Docs

Connected providers with health, quota, cost, capabilities and routing

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

Permission: providers:view

Credentials are never returned. Outage, webhooks-silent and rejected-credential states are included when they apply.

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
authFailure
object
down
required
object
credentialLabel
string
errors
required
Array<object>
object
at
required
string format: date-time
code
required
string
message
required
string
op
required
string
status
required
integer format: int64
lastSuccessAt
string format: date-time
lastSuccessOp
string
reason
required
string
Allowed values: outage auth
since
required
string format: date-time
statusLabel
string
statusSummary
string
statusUrl
string
provider
required
string
providerId
required
string
rerouted
required
integer format: int64
short
required
string
streams
required
Array<object>
object
alternatives
required
Array<object>
object
exceedsCap
required
boolean
name
required
string
providerId
required
string
recommended
required
boolean
short
required
string
warmingUp
required
boolean
campaign
object
decision

Wait, move or cancel once someone decided

string
held
required
integer format: int64
id
required
string
name
required
string
otherShares
required
Array<object>
object
color
required
string
Allowed values: ses postal postmark other
percent
required
integer format: int64
providerId
required
string
short
required
string
planned
required
integer format: int64
sent
required
integer format: int64
fallback
string
fallbackShort
string
policy
required
string
Allowed values: automatic pause_and_ask warm_only
primary
string
rerouted
required
integer format: int64
reroutedBy
required
Array<object>
object
count
required
integer format: int64
name
required
string
role
required
string
Allowed values: primary split fallback condition
since
required
string format: date-time
state
required
string
Allowed values: failover_active waiting held fallback_unavailable
stream
required
string
Allowed values: broadcast automation system transactional
suggestion
string
switchBackMinutes
required
integer format: int64
outage
object
codes
required
Array<string>
down
required
object
credentialLabel
string
errors
required
Array<object>
object
at
required
string format: date-time
code
required
string
message
required
string
op
required
string
status
required
integer format: int64
lastSuccessAt
string format: date-time
lastSuccessOp
string
reason
required
string
Allowed values: outage auth
since
required
string format: date-time
statusLabel
string
statusSummary
string
statusUrl
string
errorRate
number format: double
forecasts
required
Array<object>
object
nextTierAdds
integer format: int64
nextTierPrice
number format: double
perDay
required
integer format: int64
providerId
required
string
runsOutOn
string format: date-time
stream
required
string
incidents
required
Array<object>
object
at
required
string format: date-time
campaignId
string
detail
required
string
id
required
string
kind
required
string
severity
required
string
Allowed values: info ok warn bad
title
required
string
operation
required
string
provider
required
string
providerId
required
string
short
required
string
since
required
string format: date-time
streams
required
Array<object>
object
alternatives
required
Array<object>
object
exceedsCap
required
boolean
name
required
string
providerId
required
string
recommended
required
boolean
short
required
string
warmingUp
required
boolean
campaign
object
decision

Wait, move or cancel once someone decided

string
held
required
integer format: int64
id
required
string
name
required
string
otherShares
required
Array<object>
object
color
required
string
Allowed values: ses postal postmark other
percent
required
integer format: int64
providerId
required
string
short
required
string
planned
required
integer format: int64
sent
required
integer format: int64
fallback
string
fallbackShort
string
policy
required
string
Allowed values: automatic pause_and_ask warm_only
primary
string
rerouted
required
integer format: int64
reroutedBy
required
Array<object>
object
count
required
integer format: int64
name
required
string
role
required
string
Allowed values: primary split fallback condition
since
required
string format: date-time
state
required
string
Allowed values: failover_active waiting held fallback_unavailable
stream
required
string
Allowed values: broadcast automation system transactional
suggestion
string
switchBackMinutes
required
integer format: int64
whyNot
required
Array<object>
object
ageDays
required
integer format: int64
held
required
integer format: int64
multiple
required
number format: double
providerId
required
string
rate
required
number format: double
todayCap
required
integer format: int64
providers
required
Array<object>
object
account
required
string
accountKind
required
string
Allowed values: account server
adapter
required
string
bounce
required
object
label
string
limit
required
number format: double
pause
number format: double
review
number format: double
stale
required
boolean
value

Percent over the last 7 days

number format: double
capabilities
required
Array<object>
object
kind
required
string
Allowed values: yes partial no info
label
required
string
checkedAt
string format: date-time
color
required
string
Allowed values: ses postal postmark other
complaint
required
object
label
string
limit
required
number format: double
pause
number format: double
review
number format: double
stale
required
boolean
value

Percent over the last 7 days

number format: double
connectedAt
required
string format: date-time
cost
required
object
basis
required
string
Allowed values: metered plan self_hosted
monthly
number format: double
per1000
number format: double
source
string
toDate
required

Dollars this month

number format: double
credentials
required
Array<object>
object
key
required
string
label
required
string
set
required
boolean
down
object
credentialLabel
string
errors
required
Array<object>
object
at
required
string format: date-time
code
required
string
message
required
string
op
required
string
status
required
integer format: int64
lastSuccessAt
string format: date-time
lastSuccessOp
string
reason
required
string
Allowed values: outage auth
since
required
string format: date-time
statusLabel
string
statusSummary
string
statusUrl
string
errorRate3m
number format: double
errorRate7d

Percent of API calls that failed

number format: double
id
required
string
ipMode
required
string
Allowed values: shared dedicated
ips
required
Array<string>
label
required
string
name
required
string
quota
required
object
fromFailover
required
integer format: int64
kind
required
string
Allowed values: rolling_24h monthly_plan warmup_daily none
max
required
integer format: int64
used
required
integer format: int64
rate
required
object
label
string
max
required
number format: double
now
required
number format: double
peakToday
required
number format: double
throttled
required
boolean
roles
required
Array<object>
object
active
required
boolean
held
required
boolean
percent
required
integer format: int64
role
required
string
Allowed values: primary split fallback condition
stream
required
string
Allowed values: broadcast automation system transactional
short
required
string
status
required
string
Allowed values: healthy degraded down sandbox warming_up paused
takingFailover
required
Array<string>
warmup
object
day
required
integer format: int64
days
required
integer format: int64
planId
required
string
rate
required
number format: double
sentToday
required
integer format: int64
share
required
integer format: int64
status
required
string
Allowed values: active slowed paused done
todayCap
required
integer format: int64
webhook
required
object
kind
required
string
lastEventAt
string format: date-time
silentSince
string format: date-time
routing
required
Array<object>
object
conditions
required
integer format: int64
failover
required
string
Allowed values: automatic pause_and_ask warm_only
fallback
object
color
required
string
Allowed values: ses postal postmark other
percent
required
integer format: int64
providerId
required
string
short
required
string
splits
required
Array<object>
object
color
required
string
Allowed values: ses postal postmark other
percent
required
integer format: int64
providerId
required
string
short
required
string
stream
required
string
Allowed values: broadcast automation system transactional
silent
object
accepted
required
integer format: int64
awaiting
required
Array<object>
object
at
required
string format: date-time
deliveredAt
string format: date-time
providerMessageId
required
string
recipient
required

Masked

string
source
required
string
status
required
string
Allowed values: accepted delivered bounced deferred complained rejected
broadcastPolicy
required
string
Allowed values: automatic pause_and_ask warm_only
broadcastShareHeld
required
boolean
campaigns
required
Array<object>
object
count
required
integer format: int64
name
required
string
canBackfill
required
boolean
canRegister
required
boolean
canSendTest
required
boolean
causes
required
Array<string>
checks
required
Array<object>
object
at
string format: date-time
count
integer format: int64
detail
string
id
string
key
required
string
Allowed values: api registered endpoint provider_log
ok
boolean
queued
integer format: int64
url
string
hourly
required
Array<integer>
hourlyFrom
required
string format: date-time
provider
required
string
providerId
required
string
short
required
string
since
required
string format: date-time
webhookUrl
required
string
summary
required
object
byStatus
required
Array<object>
object
count
required
integer format: int64
status
required
string
Allowed values: healthy degraded down sandbox warming_up paused
checkedAt
string format: date-time
connected
required
integer format: int64
costPer1000
number format: double
costToDate
required

Dollars

number format: double
inSync
required
boolean
monthStart
required
string format: date-time
sentBy
required
Array<object>
object
providerId
required
string
short
required
string
value
required
number format: double
sentThisMonth
required
integer format: int64
suppressions
required
integer format: int64
syncedAt
string format: date-time

Example 

{
  "authFailure": {
    "down": {
      "reason": "outage"
    },
    "streams": [
      {
        "campaign": {
          "otherShares": [
            {
              "color": "ses"
            }
          ]
        },
        "policy": "automatic",
        "role": "primary",
        "state": "failover_active",
        "stream": "broadcast"
      }
    ]
  },
  "outage": {
    "down": {
      "reason": "outage"
    },
    "incidents": [
      {
        "severity": "info"
      }
    ],
    "streams": [
      {
        "campaign": {
          "otherShares": [
            {
              "color": "ses"
            }
          ]
        },
        "policy": "automatic",
        "role": "primary",
        "state": "failover_active",
        "stream": "broadcast"
      }
    ]
  },
  "providers": [
    {
      "accountKind": "account",
      "capabilities": [
        {
          "kind": "yes"
        }
      ],
      "color": "ses",
      "cost": {
        "basis": "metered"
      },
      "down": {
        "reason": "outage"
      },
      "ipMode": "shared",
      "quota": {
        "kind": "rolling_24h"
      },
      "roles": [
        {
          "role": "primary",
          "stream": "broadcast"
        }
      ],
      "status": "healthy",
      "warmup": {
        "status": "active"
      }
    }
  ],
  "routing": [
    {
      "failover": "automatic",
      "fallback": {
        "color": "ses"
      },
      "splits": [
        {
          "color": "ses"
        }
      ],
      "stream": "broadcast"
    }
  ],
  "silent": {
    "awaiting": [
      {
        "status": "accepted"
      }
    ],
    "broadcastPolicy": "automatic",
    "checks": [
      {
        "key": "api"
      }
    ]
  },
  "summary": {
    "byStatus": [
      {
        "status": "healthy"
      }
    ]
  }
}

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