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

Retrieve inbox placement analytics stats by test id

cURL

curl --request POST \
  --url https://api.instantly.ai/api/v2/inbox-placement-analytics/stats-by-test-id \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "test_ids": [
    "019e3bd1-b5a3-76ae-92f9-4f9cf33fadbc"
  ]
}
'

200

[
  {
    "test_id": "019e3bd1-b5a4-75e6-a9d0-11336a70423e",
    "count": 1,
    "spam_count": 1,
    "spam_percent": 1,
    "inbox_count": 1,
    "inbox_percent": 1,
    "category_count": 1,
    "category_percent": 1
  }
]

Authorizations

Authorization · string · header · required

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

Body

application/json

test_ids · string<uuid>[] · required

Minimum array length: 1

date_from · string

Example:

"2026-05-18T16:00:59.811Z"

date_to · string

Example:

"2026-05-18T16:00:59.811Z"

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]

sender_email · string

Example:

"[e-mail]"

Response

200

application/json

Default Response

test_id · string<uuid> · required

Example:

"019e3bd1-b5a4-75e6-a9d0-11336a70423e"

count · number · required

Example:

1

spam_count · number · required

Example:

1

spam_percent · number · required

Example:

1

inbox_count · number · required

Example:

1

inbox_percent · number · required

Example:

1

category_count · number · required

Example:

1

category_percent · number · required

Example:

1