Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
InboxPlacementAnalytics

Get inbox placement analytics

Requires one of the following scopes: inbox_placement_analytics:read, inbox_placement_analytics:all, all:read, all:all

get/api/v2/inbox-placement-analytics/{id}

Path parameters

idstring uuid required
Example:019f94cd-aea5-758d-8baf-56914251c110

The ID of the requested item

Response

The requested Inbox Placement Analytics

idstring uuid required

Unique identifier for the inbox placement analytics entry

timestamp_createdstring required

Timestamp when the inbox placement analytics was created

timestamp_created_datestring required

Date when the inbox placement analytics was created

organization_idstring uuid required

Organization ID

test_idstring uuid required

Inbox Placement Test ID

is_spamboolean nullable

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

has_categoryboolean nullable

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

sender_emailstring nullable

Email address of the sender

sender_esp1 | 2 | 8 | 12 | 13 nullable

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

recipient_emailstring nullable

Email address of the recipient

recipient_esp1 | 2 | 8 | 12 | 13 nullable

The recipient ESP (Email Service Provider)

recipient_geo1 | 2 | 3 | 4 nullable

The geographic location of the recipient

recipient_type1 | 2 nullable

The type of recipient

spf_passboolean nullable

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

dkim_passboolean nullable

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

dmarc_passboolean nullable

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

smtp_ip_blacklist_reportobject nullable

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

record_type1 | 2 nullable

The type of record (sent or received)

Example response

{
  "id": "019f94cd-8399-7ab6-b759-c049802ad47e",
  "timestamp_created": "2026-07-24T15:45:24.377Z",
  "timestamp_created_date": "2026-07-24",
  "organization_id": "019f94cd-839a-7633-b8d8-1811b44eeb4d",
  "test_id": "019f94cd-839a-7633-b8d8-18123a0a6f62",
  "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,
  "authentication_failure_results": {
    "authentication_results": "Authentication-Results: smtp.local;\r\n\tdkim=pass header.d=gappssmtp.com\r\n header.b=ABC123",
    "dkim_signature": "DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gappssmtp.com; s=20161025;\r\n h=mime-version:from:date:message-id:subject:to; bh=ABC123; b=ABC123",
    "received_spf": "Received-SPF: pass"
  },
  "record_type": 1
}