Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
InboxPlacementAnalytics

Get inbox placement analytics stats by date

Provides a time series representing the distribution of emails sent to inbox, spam, or category folders for scheduled inbox placement tests.

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-date

Request body

test_idstring uuid required
date_fromstring
date_tostring
recipient_geonumber[]
recipient_typenumber[]
recipient_espnumber[]
sender_emailstring

Example request

{
  "test_id": "019f94cd-aea7-7ee1-ac1e-4910d1a4ce39",
  "date_from": "2026-07-24T15:45:35.399Z",
  "date_to": "2026-07-24T15:45:35.399Z",
  "recipient_geo": [
    1
  ],
  "recipient_type": [
    1
  ],
  "recipient_esp": [
    1,
    2
  ],
  "sender_email": "john@doe.com"
}

Response

Default Response

timestamp_created_datestring required
sent_countnumber required
received_countnumber required
spam_countnumber required
inbox_countnumber required
category_countnumber required

Example response

[
  {
    "timestamp_created_date": "2026-07-24T15:45:35.400Z",
    "sent_count": 1,
    "received_count": 1,
    "spam_count": 1,
    "inbox_count": 1,
    "category_count": 1
  }
]