Skip to content

Alerts (0.0.1)

Our alerting solution is centered around two concepts: events and channels. The occurrence of an event can be configured to trigger an alert. A channel describes the delivery method for an alert. Every configured alert consists of an event type / channel pair. This level of granularity allows alerting to be configured to your exact preference.

Download OpenAPI description
openapi-final.json
openapi-final.yaml
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

https://api.eu.mailgun.net/

Domains

Operations

DMARC Reports

DMARC reporting provides valuable insights into your infrastructure, helping you identify potential issues like senders, misconfigured email servers, or phishing attempts.

Operations

Inbox Placement

Inbox Placement testing allows you to see the likely deliverability of your email campaigns.

Operations

Spam Traps Monitoring

Our spam trap monitoring service surfaces how much of your email is being sent to known spam traps.

Operations

Email Health Score

Operations

Get Email Health score and rates for account and subaccounts

Request

Security
basicAuth
Query
include_subaccountsboolean

Include subaccounts

Default true
curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/maverick-score/total?include_subaccounts=true'

Responses

A 200 response

Bodyapplication/json
scoreinteger(int32)required
ratesobject(Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Rates)required
rates.​bounce_rateinteger(int32)required
rates.​complaint_rateinteger(int32)required
rates.​trap_rateinteger(int32)required
rates.​full_mailbox_rateinteger(int32)required
rates.​bad_failure_rateinteger(int32)required
countersobject(Maverick_Score_github.com-mailgun-maverick-score-internal-api-Counters)required
counters.​deliveredinteger(int64)required
Response
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/timestamps

Request

Security
basicAuth
Query
include_subaccountsboolean

Include subaccounts

Default true
skipinteger

Skips N items in a response.

Default 0
limitinteger[ 1 .. 100 ]

Limits the number of items returned in a response.

Default 10
groupstring

The key to group score by.

Default "domain"
Enum ValueDescription
domain

Group by domain

ip

Group by IP

subaccount

Group by subaccount

timestamp

Group by timestamp in 'YYYY-MM-DD' format

termArray of strings

Filter (exact match) by account_id/domain/ip, e.g.: 'domain:example.com'

querystring

Query filter (fuzzy), e.g.: 'domain:example.com'

sortstring

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

Enum ValueDescription
domain:asc

domain:asc

domain:desc

domain:desc

ip:asc

ip:asc

ip:desc

ip:desc

subaccount:asc

subaccount:asc

subaccount:desc

subaccount:desc

timestamp:asc

timestamp:asc

timestamp:desc

timestamp:desc

score:asc

score:asc

score:desc

score:desc

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/maverick-score/grouped?include_subaccounts=true&skip=0&limit=10&group=domain&term=string&query=string&sort=domain%3Aasc'

Responses

A 200 response

Bodyapplication/json
itemsArray of objects(Maverick_Score_github.com-mailgun-maverick-score-internal-api-GroupScore)required
items[].​group_keystringrequired
items[].​account_idstring
items[].​scoreinteger(int32)required
items[].​ratesobject(Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Rates)required
items[].​rates.​bounce_rateinteger(int32)required
items[].​rates.​complaint_rateinteger(int32)required
items[].​rates.​trap_rateinteger(int32)required
items[].​rates.​full_mailbox_rateinteger(int32)required
items[].​rates.​bad_failure_rateinteger(int32)required
items[].​countersobject(Maverick_Score_github.com-mailgun-maverick-score-internal-api-Counters)required
items[].​counters.​deliveredinteger(int64)required
totalinteger(int64)required
Response
application/json
{
  "items": [
    { … }
  ],
  "total": 1
}

IP Blocklist Monitoring

Operations

Domain Blocklist Monitoring

Blocklist Monitoring enables you to keep an eye on your reputation. Monitor your domains against our curated list of blocklist providers to make sure you aren't being blocked.

Operations

Google Postmaster Tools

This API provides access to Google Postmaster data.

Operations

Microsoft SNDS

This API provides access to Microsoft SNDS data.

Operations

Alerts

Operations