This schema describes objects returned by the Inbox Placement Analytics endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the inbox placement analytics entry (read-only) |
timestamp_created | string | Yes | Timestamp when the inbox placement analytics was created (read-only) |
timestamp_created_date | string | Yes | Date when the inbox placement analytics was created (read-only) |
organization_id | string (uuid) | Yes | Organization ID (read-only) |
test_id | string (uuid) | Yes | Inbox Placement Test ID |
is_spam | boolean, nullable | No | Indicates if the email landed in spam (null if not determined). Only present when record_type is 2 (received). |
has_category | boolean, nullable | No | Indicates if the email was categorized like promotions, social, etc. (null if not determined). Only present when record_type is 2 (received). |
sender_email | string, nullable | No | Email address of the sender |
sender_esp | number, nullable | No | The sender ESP (Email Service Provider). Only present when record_type is 2 (received).. Possible values: 1 (Google), 2 (Microsoft), 12 (Web.de), 13 (Libero.it) |
recipient_email | string, nullable | No | Email address of the recipient |
recipient_esp | number, nullable | No | The recipient ESP (Email Service Provider). Possible values: 1 (Google), 2 (Microsoft), 12 (Web.de), 13 (Libero.it) |
recipient_geo | number, nullable | No | The geographic location of the recipient. Possible values: 1 (United States), 2 (Italy), 3 (Germany), 4 (France) |
recipient_type | number, nullable | No | The type of recipient. Possible values: 1 (Professional), 2 (Personal) |
spf_pass | boolean, nullable | No | Indicates if the email passed SPF validation. Only present when record_type is 2 (received). |
dkim_pass | boolean, nullable | No | Indicates if the email passed DKIM validation. Only present when record_type is 2 (received). |
dmarc_pass | boolean, nullable | No | Indicates if the email passed DMARC validation. Only present when record_type is 2 (received). |
smtp_ip_blacklist_report | object, nullable | No | Blacklist report for the SMTP IP address. Only present when record_type is 2 (received). |
authentication_failure_results | object, nullable | No | Details of authentication failures for SPF, DKIM, and DMARC. Only present when record_type is 2 (received). |
authentication_failure_results.authentication_results | string | No | Authentication results |
authentication_failure_results.dkim_signature | string | No | DKIM signature |
authentication_failure_results.received_spf | string | No | Received SPF |
record_type | number, nullable | No | The type of record (sent or received). Possible values: 1 (Sent), 2 (Received) |