Email Health Score

Get Email Health score and rates for account and subaccounts

SecuritybasicAuth
Responses
200

A 200 response

Response Schema: application/json
score
required
integer <int32>
required
object
required
object
403

A 403 response

422

A 422 response

get/v1/maverick-score/total
Request samples
Response samples
application/json
{
  • "score": 37,
  • "rates": {
    • "bounce_rate": 9,
    • "complaint_rate": 19,
    • "trap_rate": 3,
    • "full_mailbox_rate": 3,
    • "bad_failure_rate": 29
    },
  • "counters": {
    • "delivered": 100500
    }
}

List Email Health score and rates grouped by domains/ips/subaccounts

Show domains/ips/subdomains that sent more than 10,000 messages and have at least one delivery.

SecuritybasicAuth
Request
query Parameters
skip
integer
Default: 0

Skips N items in a response.

limit
integer [ 1 .. 100 ]
Default: 10

Limits the number of items returned in a response.

group
string
Default: "domain"

The key to group score by.

Enum Value Description
domain

Group by domain

ip

Group by IP

subaccount

Group by subaccount

query
string

Query filter, e.g.: 'domain:example.com'

sort
string

Supports the following syntax 'sort=field:direction'. 'direction' must be one of asc, desc. Default 'direction' is asc.

Enum: "domain:asc" "domain:desc" "ip:asc" "ip:desc" "subaccount:asc" "subaccount:desc" "score:asc" "score:desc" "bounce_rate:asc" "bounce_rate:desc" "complaint_rate:asc" "complaint_rate:desc" "trap_rate:asc" "trap_rate:desc" "full_mailbox_rate:asc" "full_mailbox_rate:desc" "bad_failure_rate:asc" "bad_failure_rate:desc" "delivered:asc" "delivered:desc"
Responses
200

A 200 response

Response Schema: application/json
required
Array of objects
total
required
integer <int64>
403

A 403 response

get/v1/maverick-score/grouped
Request samples
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "total": 1
}