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
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

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

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
Operations
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

Request

Returns a list of all address records for an account. Each address record is for a single address on a single day.

Security
basicAuth
Query
offsetintegerrequired

The record number to begin pagination with.

limitintegerrequired

The number of records to return.

timeRangeStartintegerrequired

Unix timestamp starting time filter.

timeRangeEndintegerrequired

Unix timestamp ending time filter.

Headers
X-Mailgun-Account-Idstringrequired

The account id

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/reputationanalytics/gpt/addresses?offset=0&limit=0&timeRangeStart=0&timeRangeEnd=0' \
  -H 'X-Mailgun-Account-Id: string'

Responses

A 200 response

Bodyapplication/json
addressstringrequired
dataArray of objects(reputationanalytics_github.com-mailgun-reputationanalytics-models-address-IPAddress)required
data[].​addressstringrequired
data[].​domain_namestringrequired
data[].​reputationinteger(int32)required
data[].​datestring(date-time)required
totalinteger(int32)required
Response
application/json
{ "address": "0.0.0.0", "data": [ {} ] }

Request

Returns a list of all address records for an account belonging to a specific domain. Each address record is for a single address on a single day.

Security
basicAuth
Path
domainstringrequired
Query
offsetintegerrequired

The record number to begin pagination with.

limitintegerrequired

The number of records to return.

timeRangeStartintegerrequired

Unix timestamp starting time filter.

timeRangeEndintegerrequired

Unix timestamp ending time filter.

Headers
X-Mailgun-Account-Idstringrequired

The account id

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/reputationanalytics/gpt/domains/{domain}/addresses?offset=0&limit=0&timeRangeStart=0&timeRangeEnd=0' \
  -H 'X-Mailgun-Account-Id: string'

Responses

A 200 response

Bodyapplication/json
domainstringrequired
dataArray of objects(reputationanalytics_github.com-mailgun-reputationanalytics-models-address-IPAddress)required
data[].​addressstringrequired
data[].​domain_namestringrequired
data[].​reputationinteger(int32)required
data[].​datestring(date-time)required
totalinteger(int32)required
Response
application/json
{ "domain": "test.com", "data": [ {} ] }

Request

Returns a list of all summary records for an account. Each record is for a single domain's summary and error summary data.

Security
basicAuth
Query
offsetintegerrequired

The record number to begin pagination with.

limitintegerrequired

The number of records to return.

timeRangeStartintegerrequired

Unix timestamp starting time filter.

timeRangeEndintegerrequired

Unix timestamp ending time filter.

sortBystringrequired

Field name to sort by.

orderBystringrequired

'Asc' or 'desc' sorting.

searchFieldstringrequired

Value of the domain to search, example: mailgun.com

Headers
X-Mailgun-Account-Idstringrequired

The account id

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/reputationanalytics/gpt/summary?offset=0&limit=0&timeRangeStart=0&timeRangeEnd=0&sortBy=string&orderBy=string&searchField=string' \
  -H 'X-Mailgun-Account-Id: string'

Responses

A 200 response

Bodyapplication/json
summaryArray of objects(reputationanalytics_github.com-mailgun-reputationanalytics-api-Summary)required
summary[].​namestringrequired
summary[].​reputationnumber(float)required
summary[].​user_reported_spam_rationumber(float)required
summary[].​delivery_error_rationumber(float)required
totalinteger(int32)required
Response
application/json
{ "summary": [ {} ] }

Microsoft SNDS

This API provides access to Microsoft SNDS data.

Operations
Operations