Bounce Classification

List statistics, ordered by total bounces

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

SecuritybasicAuth
Request
query Parameters
group
string

Group response by fields: 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
full_mailbox
integer <int32>

Not compatible with 'group' param.

rule-id
string
entity-id
string
object
short-explanation
string
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
required
string

The sender domain name

entity-id
required
string

The entity ID(Email Service Entity or Spam Filter / BL)

rule-id
required
string

Rule ID

Request Body schema: application/json
optional
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
object
req
object
total
integer <int32>
get/v1/bounce-classification/domains
Request samples
Response samples
application/json
{
  • "total": 1,
  • "items": [
    • {
      }
    ]
}

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
object
required
object
full_mailbox
integer <int32>

Not compatible with 'group' param.

rule-id
string
entity-id
string
object
short-explanation
string
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
object
required
object
full_mailbox
integer <int32>

Not compatible with 'group' param.

rule-id
string
entity-id
string
object
short-explanation
string
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
object
required
object
_from
string <date-time>
403

A 403 response

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