/delivery-log

GET

/delivery-log

const url = 'https://example.com/api/v1/delivery-log?status=sent&class=delivered&direction=inbound&days=7&limit=100&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/delivery-log?status=sent&class=delivered&direction=inbound&days=7&limit=100&offset=0' \
  --header 'Authorization: Bearer <token>'

Searchable delivery log with bounce classification (delivered / hard / soft / policy / reputation / throttled). domain_admin sees only its domains.

Authorizations

bearer

Parameters

Query Parameters

string

<= 200 characters

status

string

Allowed values: sent bounced deferred expired rejected

class

string

Allowed values: delivered hard soft policy reputation throttled

direction

string

Allowed values: inbound outbound internal

domain

string

<= 253 characters

days

integer

default: 7 >= 1 <= 90

limit

integer

default: 100 >= 1 <= 500

offset

integer

0 <= 9007199254740991

Responses

200

Default Response

application/json

object

items

required

Array<object>

object

required

string

queueId

required

Any of:

string
null

string

required

string

sender

required

Any of:

string
null

string

messageId

required

Any of:

string
null

string

recipient

required

string

origTo

required

Any of:

string
null

string

relay

required

string

client

required

Any of:

string
null

string

status

required

string

Allowed values: sent bounced deferred expired rejected

class

required

string

Allowed values: delivered hard soft policy reputation throttled

dsn

required

Any of:

string
null

string

detail

required

string

direction

required

string

Allowed values: inbound outbound internal

total

required

integer

>= -9007199254740991 <= 9007199254740991

byClass

required

object

delivered

required

integer

>= -9007199254740991 <= 9007199254740991

hard

required

integer

>= -9007199254740991 <= 9007199254740991

soft

required

integer

>= -9007199254740991 <= 9007199254740991

policy

required

integer

>= -9007199254740991 <= 9007199254740991

reputation

required

integer

>= -9007199254740991 <= 9007199254740991

throttled

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "items": [
    {
      "status": "sent",
      "class": "delivered",
      "direction": "inbound"
    }
  ]
}