Skip to main content
POST
/
api
/
v2
/
inbox-placement-analytics
/
deliverability-insights
Retrieve inbox placement analytics deliverability insights
curl --request POST \
  --url https://api.instantly.ai/api/v2/inbox-placement-analytics/deliverability-insights \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "test_id": "019cc043-e36c-71ca-84c2-76fed5a0b755"
}
'
[
  {
    "test_id": "019cc043-e36c-71ca-84c2-76ff02987a0d",
    "from": "2024-01-01",
    "to": "2024-01-01",
    "previous_from": "2023-01-01",
    "previous_to": "2023-01-01",
    "sender_esp": 1,
    "recipient_esp": 1,
    "spam_percentage": 10,
    "inbox_percentage": 20,
    "category_percentage": 70,
    "prev_spam_percentage": 10,
    "prev_inbox_percentage": 56.67,
    "prev_category_percentage": 33.33
  }
]

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:

"019cc043-e36c-71ca-84c2-76fed5a0b755"

​
date_from
string
Example:

"2026-03-05T23:10:00.556Z"

​
date_to
string
Example:

"2026-03-05T23:10:00.556Z"

​
previous_date_from
string
Example:

"2026-03-05T23:10:00.556Z"

​
previous_date_to
string
Example:

"2026-03-05T23:10:00.556Z"

​
show_previous
boolean
Example:

true

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

Response

Default Response

​
test_id
string<uuid>
Example:

"019cc043-e36c-71ca-84c2-76ff02987a0d"

​
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,
12,
13
Example:

1

​
recipient_esp
enum<number>
Available options:
1,
2,
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