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

Inbox Placement

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

Operations

Email Preview

This API provides functionality to create and manage email preview tests, as well as create shareable links.

Operations

Spam Traps Monitoring

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

Operations

Get Spam Trap Hits

Request

Use this endpoint to understand how much of your mail being sent to known spam traps. This endpoint returns daily spam trap hit counts for a provided timerange, categorized by trap type.

Security
basicAuth
Query
startstringrequired

The start date in UTC (format YYYY-MM-DD) of the timeframe for which you wish to see data.

endstringrequired

The end date in UTC (format YYYY-MM-DD) of the timeframe for which you wish to see data.

sortbystring

Acceptable values include date, totals, domain, subject, ip, and from. Defaults to date.

groupbystring

Use this field to group results. Acceptable values include domain, subject, ip, and from.

subjectstring

Use this field to filter results by email subject.

domainstring

Use this field to filter results by domain(s).

ipstring

Use this field to filter results by ip(s).

fromstring

Use this field to filter results by sender email address.

limitintegerrequired

Limits the number of items returned in a request

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/spamtraps?start=string&end=string&sortby=string&groupby=string&subject=string&domain=string&ip=string&from=string&limit=0'

Responses

A 200 response

Bodyapplication/json
itemsArray of objects(Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-DatedTotals)required
items[].​datestringrequired
items[].​pristineinteger(int32)required
items[].​recycledinteger(int32)required
items[].​typointeger(int32)required
items[].​harvestedinteger(int32)required
items[].​totalinteger(int32)required
pagingobject(Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-PagingResponse)required
paging.​firststringrequired
paging.​previousstringrequired
paging.​nextstringrequired
Response
application/json
{
  "items": [
    { … },
    { … }
  ],
  "paging": {}
}

Email Health Score

Operations

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