Sender health: a 0–100 score, its word and the reasons behind it

GET

/api/v1/workspaces/{workspace}/overview/sender-health

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/overview/sender-health"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/overview/sender-health';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/overview/sender-health \
  --header 'Authorization: Bearer <token>'

Permission: deliverability:view

From the Deliverability checks (blocklists, authentication) and each provider’s bounce and complaint rates against its own limits, warm-up and status.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Responses

200

application/json

object

checkedAt

string format: date-time

domain

required

string

label

required

string

Allowed values: Good Fair Poor ""

reasons

required

Array<object>

object

action

object

asset

string

kind

required

string

Allowed values: delisting deliverability providers warmup integrations

label

required

Request delisting

string

key

required

string

Allowed values: blocklist_domain auth rates blocklist_ip warmup provider_status checks

text

required

string

tone

required

string

Allowed values: ok warn bad

score

required

integer format: int64

sources

required

Blocklists checked

integer format: int64

state

required

string

Allowed values: ready pending

tone

required

string

Allowed values: ok warn bad neutral

via

required

string

Allowed values: hostrepute builtin none

Example

{
  "label": "Good",
  "reasons": [
    {
      "action": {
        "kind": "delisting"
      },
      "key": "blocklist_domain",
      "tone": "ok"
    }
  ],
  "state": "ready",
  "tone": "ok",
  "via": "hostrepute"
}

default

Error

application/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"
}