Skip to main content
GET
/
api
/
v2
/
inbox-placement-analytics
/
{id}
Get inbox placement analytics
curl --request GET \
  --url https://api.instantly.ai/api/v2/inbox-placement-analytics/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

The ID of the requested item

Example:

"019dc79a-c46b-78d6-a03c-1f6d5972b722"

Response

The requested Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

​
id
string<uuid>
required

Unique identifier for the inbox placement analytics entry

Example:

"019dc79a-8149-7a08-abc4-e4ff77ae22b9"

​
timestamp_created
string
required

Timestamp when the inbox placement analytics was created

Example:

"2026-04-26T02:24:44.873Z"

​
timestamp_created_date
string
required

Date when the inbox placement analytics was created

Example:

"2026-04-26"

​
organization_id
string<uuid>
required

Organization ID

Example:

"019dc79a-8149-7a08-abc4-e500c5ab4982"

​
test_id
string<uuid>
required

Inbox Placement Test ID

Example:

"019dc79a-8149-7a08-abc4-e501a5084702"

​
is_spam
null | boolean

Indicates if the email landed in spam (null if not determined). Only present when record_type is 2 (received).

Example:

true

​
has_category
null | boolean

Indicates if the email was categorized like promotions, social, etc. (null if not determined). Only present when record_type is 2 (received).

Example:

true

​
sender_email
null | string

Email address of the sender

Example:

"sender@example.com"

​
sender_esp
null | enum<number>

The sender ESP (Email Service Provider). Only present when record_type is 2 (received).

Available options:
1,
2,
12,
13
Example:

1

​
recipient_email
null | string

Email address of the recipient

Example:

"recipient@example.com"

​
recipient_esp
null | enum<number>

The recipient ESP (Email Service Provider)

Available options:
1,
2,
12,
13
Example:

1

​
recipient_geo
null | enum<number>

The geographic location of the recipient

Available options:
1,
2,
3,
4
Example:

1

​
recipient_type
null | enum<number>

The type of recipient

Available options:
1,
2
Example:

1

​
spf_pass
null | boolean

Indicates if the email passed SPF validation. Only present when record_type is 2 (received).

Example:

true

​
dkim_pass
null | boolean

Indicates if the email passed DKIM validation. Only present when record_type is 2 (received).

Example:

true

​
dmarc_pass
null | boolean

Indicates if the email passed DMARC validation. Only present when record_type is 2 (received).

Example:

true

​
smtp_ip_blacklist_report
object

Blacklist report for the SMTP IP address. Only present when record_type is 2 (received).

​
authentication_failure_results
object

Details of authentication failures for SPF, DKIM, and DMARC. Only present when record_type is 2 (received).

​
record_type
null | enum<number>

The type of record (sent or received)

Available options:
1,
2
Example:

1