Skip to main content
GET
/
api
/
v2
/
inbox-placement-analytics
List inbox placement analytics
curl --request GET \
  --url https://api.instantly.ai/api/v2/inbox-placement-analytics \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "019dc79a-8149-7a08-abc4-e4ff77ae22b9",
      "timestamp_created": "2026-04-26T02:24:44.873Z",
      "timestamp_created_date": "2026-04-26",
      "organization_id": "019dc79a-8149-7a08-abc4-e500c5ab4982",
      "test_id": "019dc79a-8149-7a08-abc4-e501a5084702",
      "is_spam": true,
      "has_category": true,
      "sender_email": "sender@example.com",
      "sender_esp": 1,
      "recipient_email": "recipient@example.com",
      "recipient_esp": 1,
      "recipient_geo": 1,
      "recipient_type": 1,
      "spf_pass": true,
      "dkim_pass": true,
      "dmarc_pass": true,
      "smtp_ip_blacklist_report": {},
      "authentication_failure_results": {
        "authentication_results": "<string>",
        "dkim_signature": "<string>",
        "received_spf": "<string>"
      },
      "record_type": 1
    }
  ],
  "next_starting_after": "019dc79a-c46a-7c9e-b3d6-a01f6a1bdbf3"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer

The number of items to return

Required range: 1 <= x <= 100
Example:

10

​
starting_after
string

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Example:

"01956fbd-0eb1-72db-a565-82977a586084"

​
test_id
string<uuid>
required
Example:

"019dc79a-c469-7e02-b69c-c80d8651ea94"

​
date_from
string
Example:

"2026-04-26T02:25:02.058Z"

​
date_to
string
Example:

"2026-04-26T02:25:02.058Z"

​
recipient_geo
string

A comma-separated list of recipient geo values.

Example:

"1,2"

​
recipient_type
string

A comma-separated list of recipient type values.

Example:

"1,2"

​
recipient_esp
string

A comma-separated list of recipient ESP values.

Example:

"1,2"

​
sender_email
string
Example:

"john@doe.com"

Response

The list of Inbox Placement Analytics

​
items
Inbox Placement Analytics · object[]
required

The list of Inbox Placement Analytics

​
next_starting_after
string

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example:

"019dc79a-c46a-7c9e-b3d6-a01f6a1bdbf3"