Skip to main content
This schema describes objects returned by the Inbox Placement Analytics endpoints.

Analytics data for individual emails in inbox placement tests

​
id
string<uuid>
required
read-only

Unique identifier for the inbox placement analytics entry

Example:

"019f985c-6304-7477-9033-ef27ab7e1cf3"

​
timestamp_created
string
required
read-only

Timestamp when the inbox placement analytics was created

Example:

"2026-07-25T08:20:19.332Z"

​
timestamp_created_date
string
required
read-only

Date when the inbox placement analytics was created

Example:

"2026-07-25"

​
organization_id
string<uuid>
required
read-only

Organization ID

Example:

"019f985c-6304-7477-9033-ef2855f633f1"

​
test_id
string<uuid>
required

Inbox Placement Test ID

Example:

"019f985c-6304-7477-9033-ef29996e4e7b"

​
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,
8,
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,
8,
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
null | object

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

​
authentication_failure_results
null | 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