v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

InboxPlacementAnalytics

List 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

Query parameters

limitinteger

Example:10

The number of items to return

starting_afterstring

Example:01956fbd-0eb1-72db-a565-82977a586084

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.

test_idstring uuid required

Example:019f94cd-aea3-74b5-acba-5588c9e616ab

date_fromstring

Example:2026-07-24T15:45:35.396Z

date_tostring

Example:2026-07-24T15:45:35.396Z

recipient_geostring

Example:1,2

A comma-separated list of recipient geo values.

recipient_typestring

Example:1,2

A comma-separated list of recipient type values.

recipient_espstring

Example:1,2

A comma-separated list of recipient ESP values.

sender_emailstring

Example:john@doe.com

Response

The list of Inbox Placement Analytics

next_starting_afterstring

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 response

{
  "items": [
    {
      "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
    }
  ],
  "next_starting_after": "019f94cd-aea4-78e1-a666-2b7d5fe748da"
}