INinstantly
InboxPlacementAnalytics

Retrieve inbox placement analytics deliverability insights

Provides deliverability insights for a specific inbox placement test

Requires one of the following scopes: inbox_placement_analytics:read, inbox_placement_analytics:all, all:read, all:all

post/api/v2/inbox-placement-analytics/deliverability-insights

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/inbox-placement-analytics/deliverability-insights
  • Auth
    HTTP bearer

Request body

test_idstring uuid required
date_fromstring
date_tostring
previous_date_fromstring
previous_date_tostring
show_previousboolean
recipient_geonumber[]
recipient_typenumber[]
recipient_espnumber[]

Example request

{
  "test_id": "01a19e6d-9197-7818-917a-7576082458f4",
  "date_from": "2026-11-02T22:42:23.255Z",
  "date_to": "2026-11-02T22:42:23.255Z",
  "previous_date_from": "2026-11-02T22:42:23.255Z",
  "previous_date_to": "2026-11-02T22:42:23.255Z",
  "show_previous": true,
  "recipient_geo": [
    1
  ],
  "recipient_type": [
    1
  ],
  "recipient_esp": [
    1,
    2
  ]
}

Response

Default Response

test_idstring uuid
fromstring nullable
tostring nullable
previous_fromstring nullable
previous_tostring nullable
sender_esp1 | 2 | 8 | 12 | 13
recipient_esp1 | 2 | 8 | 12 | 13
spam_percentagenumber nullable
inbox_percentagenumber nullable
category_percentagenumber nullable
prev_spam_percentagenumber nullable
prev_inbox_percentagenumber nullable
prev_category_percentagenumber nullable

Example response

[
  {
    "test_id": "01a19e6d-9197-7818-917a-75771bcadb44",
    "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
  }
]

Changes

No recorded changes to this operation across all 8 revisions of this API.