Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
InboxPlacementAnalytics

Retrieve inbox placement analytics stats by test id

Provides aggregated inbox, spam and category counts for specified test IDs

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

post/api/v2/inbox-placement-analytics/stats-by-test-id

Request body

test_idsstring[] required
date_fromstring
date_tostring
recipient_geonumber[]
recipient_typenumber[]
recipient_espnumber[]
sender_emailstring

Example request

{
  "test_ids": [
    "019f94cd-aea5-758d-8baf-5692202f75a4"
  ],
  "date_from": "2026-07-24T15:45:35.397Z",
  "date_to": "2026-07-24T15:45:35.397Z",
  "recipient_geo": [
    1
  ],
  "recipient_type": [
    1
  ],
  "recipient_esp": [
    1,
    2
  ],
  "sender_email": "john@doe.com"
}

Response

Default Response

test_idstring uuid required
countnumber required
spam_countnumber required
spam_percentnumber required
inbox_countnumber required
inbox_percentnumber required
category_countnumber required
category_percentnumber required

Example response

[
  {
    "test_id": "019f94cd-aea5-758d-8baf-56939cb86c03",
    "count": 1,
    "spam_count": 1,
    "spam_percent": 1,
    "inbox_count": 1,
    "inbox_percent": 1,
    "category_count": 1,
    "category_percent": 1
  }
]