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&duration=7d&limit=10

SecuritybasicAuth
Request
query Parameters
group
string

Group response by fields: subaccount.id, domain.name, entity-id, rule-id

duration
string

Period of time in days to show statistic for, e.g. '30d'. Default is '7d'

limit
integer

Limits the number of items returned in a response

Responses
200

A 200 response

Response Schema: application/json
required
Array of objects
Array
required
object
object
object
rule-id
string
entity-id
string
short-explanation
string
full_mailbox
integer <int32>

Not compatible with 'group' param.

get/v1/bounce-classification/stats
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      }
    ]
}
Dismiss bounces from GET /v1/bounce-classification/stats
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
 
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'


 
Responses 
200
A 200 response


Response Schema: application/json
required
Array of objects
 
total
integer <int32> 
 
req
object
 
get/v1/bounce-classification/domains
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      }
    ],
  • "total": 1
}
List statistic per domain
SecuritybasicAuth 
Request 
path Parameters
domain
required
string
The sender domain name


 
Responses 
200
A 200 response


Response Schema: application/json
required
Array of objects
 
 Array 
entity-id
required
string
 
entity-name
required
string
 
required
object
 
get/v1/bounce-classification/domains/{domain}/entities
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      },
    • {
      }
    ]
}
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)


 
Responses 
200
A 200 response


Response Schema: application/json
required
Array of objects
 
 Array 
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 
application/json
{
  • "items": [
    • {
      }
    ]
}
List Bounce 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 
200
A 200 response


Response Schema: application/json
required
Array of objects
 
required
object
 
_from
string <date-time> 
 
403
A 403 response


get/v1/bounce-classification/domains/{domain}/events
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      }
    ],
  • "paging": {},
  • "_from": "0001-01-01 00:00:00 +0000 UTC"
}
List entities
SecuritybasicAuth 
Responses 
200
A 200 response


Response Schema: application/json
additional property
object
 
name
required
string
 
domains
Array of strings
 
get/v1/bounce-classification/config/entities
Request samples 
Response samples 
application/json
null
Cookie PolicyGDPR Email ComplianceAcceptable Use PolicyTerms of ServicePrivacy Policy
© 2024 Sinch Mailgun. All rights reserved.