INinstantly
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

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/inbox-placement-analytics
  • Auth
    HTTP bearer

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:01a19e6e-65fa-740b-a4a3-8ff883963c58
date_fromstring
Example:2026-11-02T22:43:17.626Z
date_tostring
Example:2026-11-02T22:43:17.626Z
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": "01a19e6e-2768-7045-a73e-ca93039bac37",
      "timestamp_created": "2026-11-02T22:43:01.608Z",
      "timestamp_created_date": "2026-11-02",
      "organization_id": "01a19e6e-2768-7045-a73e-ca94c764aebe",
      "test_id": "01a19e6e-2768-7045-a73e-ca953c4e49c6",
      "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": "01a19e6e-65fa-740b-a4a3-8ff9662e9f4f"
}

Changes

No recorded changes to this operation across all 9 revisions of this API.