Skip to main content
POST
Retrieve inbox placement analytics deliverability insights

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
test_id
string<uuid>
required
Example:

"019f7ffb-d8b8-736d-90e8-740fed3f1fa7"

date_from
string
Example:

"2026-07-20T14:43:59.288Z"

date_to
string
Example:

"2026-07-20T14:43:59.288Z"

previous_date_from
string
Example:

"2026-07-20T14:43:59.288Z"

previous_date_to
string
Example:

"2026-07-20T14:43:59.288Z"

show_previous
boolean
Example:

true

recipient_geo
enum<number>[]
Available options:
1,
2,
3,
4
Example:
recipient_type
enum<number>[]
Available options:
1,
2
Example:
recipient_esp
enum<number>[]
Available options:
1,
2,
8,
12,
13
Example:

Response

Default Response

test_id
string<uuid>
Example:

"019f7ffb-d8b8-736d-90e8-74105fba7f9c"

from
null | string
Example:

"2024-01-01"

to
null | string
Example:

"2024-01-01"

previous_from
null | string
Example:

"2023-01-01"

previous_to
null | string
Example:

"2023-01-01"

sender_esp
enum<number>
Available options:
1,
2,
8,
12,
13
Example:

1

recipient_esp
enum<number>
Available options:
1,
2,
8,
12,
13
Example:

1

spam_percentage
null | number
Example:

10

inbox_percentage
null | number
Example:

20

category_percentage
null | number
Example:

70

prev_spam_percentage
null | number
Example:

10

prev_inbox_percentage
null | number
Example:

56.67

prev_category_percentage
null | number
Example:

33.33