Bounce Classification

List statistics, ordered by total bounces

e.g. /v1/bounce-classification/stats?group=domain.name&group=entity-id&group=rule-id&group=subaccount.id&limit=10

SecuritybasicAuth

Request

query Parameters

group	string Group response by fields: subaccount.id, domain.name, entity-id, rule-id
limit	integer Limits the number of items returned in a response
include_subaccounts	boolean Default: false Include subaccounts

Responses

200

A 200 response

Response Schema: application/json

required	Array of Bounce_Classification_github.com-mailgun-bounce-classification-entities-Stat (object) or null
required	object

get/v1/bounce-classification/stats

Request samples

Response samples

200

application/json

{"items": [{"subaccount": {"id": "subaccount_id"
},
"domain": {"name": "example.com"
},
"rule-id": "55ff",
"entity-id": "spamhaus",
"short-explanation": "You're listed on Spamhaus!",
"bounced": {"total": 4
}
}
],
"_duration": "0s"
}

Dismiss bounces from GET /v1/bounce-classification/statsDeprecated

SecuritybasicAuth

Request

query Parameters

domain.name	string The sender domain name
entity-id	string The entity ID(Email Service Entity or Spam Filter / BL)
rule-id	string Rule ID

Request Body schema: application/json
required

is-dismissed

required

boolean or null

Responses

204

A 204 response

patch/v1/bounce-classification/stats

Request samples

application/json

{"is-dismissed": true
}

List domains statistic per account

SecuritybasicAuth

Request

query Parameters

limit	integer Limits the number of items returned in a response
skip	integer Skips N items in a response
query	string Query filter, e.g.: 'domain.name:example.com'
include_subaccounts	boolean Default: false Include subaccounts

Responses

200

A 200 response

Response Schema: application/json

required	Array of Bounce_Classification_github.com-mailgun-bounce-classification-entities-AccountStat (object) or null
total	integer or null <int32>
req	object

get/v1/bounce-classification/domains

Request samples

Response samples

200

application/json

{"items": [{"domain": {"name": "mailgun.net"
},
"bounced": {"total": 4
}
}
],
"total": 1
}

List statistic per domain

SecuritybasicAuth

Request

path Parameters

domain

required

string

The sender domain name

query Parameters

include_subaccounts

boolean

Default: false

Include subaccounts

Responses

200

A 200 response

Response Schema: application/json

required

Array of Bounce_Classification_github.com-mailgun-bounce-classification-entities-DomainStat (object) or null

Array

Any of:

entity-id required	string
entity-name required	string
required	object

get/v1/bounce-classification/domains/{domain}/entities

Request samples

Response samples

200

application/json

{"items": [{"entity-id": "gmail",
"entity-name": "Gmail",
"bounced": {"total": 1
}
},
{"entity-id": "hotmail",
"entity-name": "Microsoft (Hotmail)",
"bounced": {"total": 3
}
}
]
}

List statistic per entity

SecuritybasicAuth

Request

path Parameters

domain required	string The sender domain name
entity-id required	string The entity ID(Email Service Entity or Spam Filter / BL)

query Parameters

include_subaccounts

boolean

Default: false

Include subaccounts

Responses

200

A 200 response

Response Schema: application/json

required

Array of Bounce_Classification_github.com-mailgun-bounce-classification-entities-EntityStat (object) or null

Array

Any of:

rule-id required	string
category required	string
severity required	string
sample-text required	string
explanation required	string
required	object

403

A 403 response

get/v1/bounce-classification/domains/{domain}/entities/{entity-id}/rules

Request samples

Response samples

200
403

application/json

{"items": [{"rule-id": "55ff",
"category": "ESPBLOCK",
"severity": "PERMANENT",
"sample-text": "5.4.1 recipient address rejected: access denied.",
"explanation": "Access denied",
"bounced": {"total": 3
}
}
]
}

List Bounce LogsDeprecated

Deprecated: use POST /v1/analytics/logs - https://documentation.mailgun.com/docs/mailgun/api-reference/openapi-final/tag/Logs/

SecuritybasicAuth

Request

path Parameters

domain

required

string

The sender domain name

query Parameters

rule-id	string Optional if 'page' is passed
entity-id	string The entity ID(Email Service Entity or Spam Filter / BL)
sort	string Sort field and order. Default is '@timestamp:asc'
page	string Encoded paging information, provided via 'next', 'previous' links
limit	integer Limits the number of items returned in a response

Responses

403

A 403 response

410

A 410 response

get/v1/bounce-classification/domains/{domain}/events

Request samples

Response samples

403
410

application/json

{"message": "string"
}

List entities

SecuritybasicAuth

Responses

200

A 200 response

Response Schema: application/json

additional property

object

name

required

string

get/v1/bounce-classification/config/entities

Request samples

Response samples

200

application/json

null

List rules

SecuritybasicAuth

Responses

200

A 200 response

Response Schema: application/json

additional property

object

entity_id	string
class	string
sample-text	string
explanation	string
short-explanation	string

get/v1/bounce-classification/config/rules

Request samples

Response samples

200

application/json

null

Bounce Classification

List statistics, ordered by total bounces

query Parameters

Response Schema: application/json

Dismiss bounces from GET /v1/bounce-classification/statsDeprecated

query Parameters

Request Body schema: application/jsonrequired

List domains statistic per account

query Parameters

Response Schema: application/json

List statistic per domain

path Parameters

query Parameters

Response Schema: application/json

List statistic per entity

path Parameters

query Parameters

Response Schema: application/json

List Bounce LogsDeprecated

path Parameters

query Parameters

List entities

Response Schema: application/json

List rules

Response Schema: application/json

Request Body schema: application/json
required