Inbox Placement Analytics
/
Get inbox placement analytics stats by date

API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Languages
Servers
Instantly API Server
https://api.instantly.ai/
Mock server
https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement analytics entry

Example: "01959271-1f6d-701a-a8f4-bef33bb9303e"
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement analytics was created

Example: "2025-03-14T02:17:22.029Z"
timestamp_created_datestringread-onlyrequired

Date when the inbox placement analytics was created

Example: "2025-03-14"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "01959271-1f6d-701a-a8f4-bef4632ca526"
test_idstring(uuid)required

Inbox Placement Test ID

Example: "01959271-1f6d-701a-a8f4-bef595622cc3"
is_spamnumber

Indicates if the email landed in spam (1 for spam, 0 otherwise)

Example: 1
has_categorynumber

Indicates if the email was categorized like promotions, social, etc.

Example: 1
sender_emailstring

Email address of the sender

Example: "sender@example.com"
sender_espnumber

The sender ESP (Email Service Provider)

Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
recipient_emailstring

Email address of the recipient

Example: "recipient@example.com"
recipient_espnumber

The recipient ESP (Email Service Provider)

Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
recipient_geonumber

The geographic location of the recipient

Enum ValueDescription
1

United States

2

Italy

3

Germany

4

France

Example: 1
recipient_typenumber

The type of recipient

Enum ValueDescription
1

Professional

2

Personal

Example: 1
spf_passnumber

Indicates if the email passed SPF validation (1 for pass, 0 otherwise)

Example: 1
dkim_passnumber

Indicates if the email passed DKIM validation (1 for pass, 0 otherwise)

Example: 1
dmarc_passnumber

Indicates if the email passed DMARC validation (1 for pass, 0 otherwise)

Example: 1
smtp_ip_blacklist_reportobject

Blacklist report for the SMTP IP address

authentication_failure_resultsobject

Details of authentication failures for SPF, DKIM, and DMARC

{
  "id": "01959271-1f6d-701a-a8f4-bef33bb9303e",
  "timestamp_created": "2025-03-14T02:17:22.029Z",
  "timestamp_created_date": "2025-03-14",
  "organization_id": "01959271-1f6d-701a-a8f4-bef4632ca526",
  "test_id": "01959271-1f6d-701a-a8f4-bef595622cc3",
  "is_spam": 1,
  "has_category": 1,
  "sender_email": "sender@example.com",
  "sender_esp": 1,
  "recipient_email": "recipient@example.com",
  "recipient_esp": 1,
  "recipient_geo": 1,
  "recipient_type": 1,
  "spf_pass": 1,
  "dkim_pass": 1,
  "dmarc_pass": 1,
  "smtp_ip_blacklist_report": {},
  "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"
  }
}

List inbox placement analytics

Request

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

Query
test_idstring(uuid)required
Example: test_id=01959271-2fc7-725b-8680-44fa6f3245d6
limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10
starting_afterstring(uuid)

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.

Example: starting_after=01956fbd-0eb1-72db-a565-82977a586084
date_fromstring
Example: date_from=2025-03-14T02:17:26.215Z
date_tostring
Example: date_to=2025-03-14T02:17:26.215Z
recipient_geostring

A comma-separated list of recipient geo values.

Example: recipient_geo=1,2
recipient_typestring

A comma-separated list of recipient type values.

Example: recipient_type=1,2
recipient_espstring

A comma-separated list of recipient ESP values.

Example: recipient_esp=1,2
sender_emailstring
Example: sender_email=john@doe.com
curl -i -X GET \
  'https://api.instantly.ai/api/v2/inbox-placement-analytics?date_from=2025-03-14T02%3A17%3A26.215Z&date_to=2025-03-14T02%3A17%3A26.215Z&limit=10&recipient_esp=1%2C2&recipient_geo=1%2C2&recipient_type=1%2C2&sender_email=john%40doe.com&starting_after=01956fbd-0eb1-72db-a565-82977a586084&test_id=01959271-2fc7-725b-8680-44fa6f3245d6' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Inbox Placement Analytics

Bodyapplication/json
itemsArray of objects(Inbox Placement Analytics)required
items[].​idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement analytics entry

Example: "01959271-1f6d-701a-a8f4-bef33bb9303e"
items[].​timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement analytics was created

Example: "2025-03-14T02:17:22.029Z"
items[].​timestamp_created_datestringread-onlyrequired

Date when the inbox placement analytics was created

Example: "2025-03-14"
items[].​organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "01959271-1f6d-701a-a8f4-bef4632ca526"
items[].​test_idstring(uuid)required

Inbox Placement Test ID

Example: "01959271-1f6d-701a-a8f4-bef595622cc3"
items[].​is_spamnumber

Indicates if the email landed in spam (1 for spam, 0 otherwise)

Example: 1
items[].​has_categorynumber

Indicates if the email was categorized like promotions, social, etc.

Example: 1
items[].​sender_emailstring

Email address of the sender

Example: "sender@example.com"
items[].​sender_espnumber

The sender ESP (Email Service Provider)

Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
items[].​recipient_emailstring

Email address of the recipient

Example: "recipient@example.com"
items[].​recipient_espnumber

The recipient ESP (Email Service Provider)

Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
items[].​recipient_geonumber

The geographic location of the recipient

Enum ValueDescription
1

United States

2

Italy

3

Germany

4

France

Example: 1
items[].​recipient_typenumber

The type of recipient

Enum ValueDescription
1

Professional

2

Personal

Example: 1
items[].​spf_passnumber

Indicates if the email passed SPF validation (1 for pass, 0 otherwise)

Example: 1
items[].​dkim_passnumber

Indicates if the email passed DKIM validation (1 for pass, 0 otherwise)

Example: 1
items[].​dmarc_passnumber

Indicates if the email passed DMARC validation (1 for pass, 0 otherwise)

Example: 1
items[].​smtp_ip_blacklist_reportobject

Blacklist report for the SMTP IP address

items[].​authentication_failure_resultsobject

Details of authentication failures for SPF, DKIM, and DMARC

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a MongoDB ID, a timestamp, on an email depending on the specific API

Example: "0000-0000-0000-0000"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "0000-0000-0000-0000"
}

Get inbox placement analytics

Request

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

Path
idstringrequired
curl -i -X GET \
  'https://api.instantly.ai/api/v2/inbox-placement-analytics/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Inbox Placement Analytics

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement analytics entry

Example: "01959271-1f6d-701a-a8f4-bef33bb9303e"
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement analytics was created

Example: "2025-03-14T02:17:22.029Z"
timestamp_created_datestringread-onlyrequired

Date when the inbox placement analytics was created

Example: "2025-03-14"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "01959271-1f6d-701a-a8f4-bef4632ca526"
test_idstring(uuid)required

Inbox Placement Test ID

Example: "01959271-1f6d-701a-a8f4-bef595622cc3"
is_spamnumber

Indicates if the email landed in spam (1 for spam, 0 otherwise)

Example: 1
has_categorynumber

Indicates if the email was categorized like promotions, social, etc.

Example: 1
sender_emailstring

Email address of the sender

Example: "sender@example.com"
sender_espnumber

The sender ESP (Email Service Provider)

Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
recipient_emailstring

Email address of the recipient

Example: "recipient@example.com"
recipient_espnumber

The recipient ESP (Email Service Provider)

Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
recipient_geonumber

The geographic location of the recipient

Enum ValueDescription
1

United States

2

Italy

3

Germany

4

France

Example: 1
recipient_typenumber

The type of recipient

Enum ValueDescription
1

Professional

2

Personal

Example: 1
spf_passnumber

Indicates if the email passed SPF validation (1 for pass, 0 otherwise)

Example: 1
dkim_passnumber

Indicates if the email passed DKIM validation (1 for pass, 0 otherwise)

Example: 1
dmarc_passnumber

Indicates if the email passed DMARC validation (1 for pass, 0 otherwise)

Example: 1
smtp_ip_blacklist_reportobject

Blacklist report for the SMTP IP address

authentication_failure_resultsobject

Details of authentication failures for SPF, DKIM, and DMARC

Response
application/json
{
  "id": "01959271-1f6d-701a-a8f4-bef33bb9303e",
  "timestamp_created": "2025-03-14T02:17:22.029Z",
  "timestamp_created_date": "2025-03-14",
  "organization_id": "01959271-1f6d-701a-a8f4-bef4632ca526",
  "test_id": "01959271-1f6d-701a-a8f4-bef595622cc3",
  "is_spam": 1,
  "has_category": 1,
  "sender_email": "sender@example.com",
  "sender_esp": 1,
  "recipient_email": "recipient@example.com",
  "recipient_esp": 1,
  "recipient_geo": 1,
  "recipient_type": 1,
  "spf_pass": 1,
  "dkim_pass": 1,
  "dmarc_pass": 1,
  "smtp_ip_blacklist_report": {},
  "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"
  }
}

Retrieve inbox placement analytics stats by test id

Request

Provides aggregated inbox, spam and category counts for specified test IDs

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

Bodyapplication/jsonrequired
test_idsArray of stringsnon-emptyrequired
date_fromstring
Example: "2025-03-14T02:17:26.216Z"
date_tostring
Example: "2025-03-14T02:17:26.216Z"
recipient_geoArray of numbers
Items Enum ValueDescription
1

United States

2

Italy

3

Germany

4

France

Example: [1]
recipient_typeArray of numbers
Items Enum ValueDescription
1

Professional

2

Personal

Example: [1]
recipient_espArray of numbers
Items Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: [1,2]
sender_emailstring
Example: "john@doe.com"
curl -i -X POST \
  https://api.instantly.ai/api/v2/inbox-placement-analytics/stats-by-test-id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "test_ids": [
      "string"
    ]
  }'

Responses

Default Response

Bodyapplication/jsonArray [
test_idstring(uuid)required
Example: "01959271-2fc8-74ef-bdc9-6bcb5ee8bded"
countnumberrequired
Example: 1
spam_countnumberrequired
Example: 1
spam_percentnumberrequired
Example: 1
inbox_countnumberrequired
Example: 1
inbox_percentnumberrequired
Example: 1
category_countnumberrequired
Example: 1
category_percentnumberrequired
Example: 1
]
Response
application/json
[
  {
    "test_id": "01959271-2fc8-74ef-bdc9-6bcb5ee8bded",
    "count": 1,
    "spam_count": 1,
    "spam_percent": 1,
    "inbox_count": 1,
    "inbox_percent": 1,
    "category_count": 1,
    "category_percent": 1
  }
]

Retrieve inbox placement analytics deliverability insights

Request

Provides deliverability insights for a specific inbox placement test

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

Bodyapplication/jsonrequired
test_idstring(uuid)required
Example: "01959271-2fc9-7b67-a3c6-115be1540532"
date_fromstring
Example: "2025-03-14T02:17:26.217Z"
date_tostring
Example: "2025-03-14T02:17:26.217Z"
previous_date_fromstring
Example: "2025-03-14T02:17:26.217Z"
previous_date_tostring
Example: "2025-03-14T02:17:26.217Z"
show_previousboolean
Example: true
recipient_geoArray of numbers
Items Enum ValueDescription
1

United States

2

Italy

3

Germany

4

France

Example: [1]
recipient_typeArray of numbers
Items Enum ValueDescription
1

Professional

2

Personal

Example: [1]
recipient_espArray of numbers
Items Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: [1,2]
curl -i -X POST \
  https://api.instantly.ai/api/v2/inbox-placement-analytics/deliverability-insights \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "test_id": "01959271-2fc9-7b67-a3c6-115be1540532"
  }'

Responses

Default Response

Bodyapplication/jsonArray [
test_idstring(uuid)
Example: "01959271-2fc9-7b67-a3c6-115cd8c644a8"
fromnull or string
Example: "2024-01-01"
tonull or string
Example: "2024-01-01"
previous_fromnull or string
Example: "2023-01-01"
previous_tonull or string
Example: "2023-01-01"
sender_espnumber
Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
recipient_espnumber
Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: 1
spam_percentagenull or number
Example: 10
inbox_percentagenull or number
Example: 20
category_percentagenull or number
Example: 70
prev_spam_percentagenull or number
Example: 10
prev_inbox_percentagenull or number
Example: 56.67
prev_category_percentagenull or number
Example: 33.33
]
Response
application/json
[
  {
    "test_id": "01959271-2fc9-7b67-a3c6-115cd8c644a8",
    "from": "2024-01-01",
    "to": "2024-01-01",
    "previous_from": "2023-01-01",
    "previous_to": "2023-01-01",
    "sender_esp": 1,
    "recipient_esp": 1,
    "spam_percentage": 10,
    "inbox_percentage": 20,
    "category_percentage": 70,
    "prev_spam_percentage": 10,
    "prev_inbox_percentage": 56.67,
    "prev_category_percentage": 33.33
  }
]

Get inbox placement analytics stats by date

Request

Provides a time series representing the distribution of emails sent to inbox, spam, or category folders for scheduled inbox placement tests.

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

Bodyapplication/jsonrequired
test_idstring(uuid)required
Example: "01959271-2fca-76df-a9bc-daf67ccf6b37"
date_fromstring
Example: "2025-03-14T02:17:26.218Z"
date_tostring
Example: "2025-03-14T02:17:26.218Z"
recipient_geoArray of numbers
Items Enum ValueDescription
1

United States

2

Italy

3

Germany

4

France

Example: [1]
recipient_typeArray of numbers
Items Enum ValueDescription
1

Professional

2

Personal

Example: [1]
recipient_espArray of numbers
Items Enum ValueDescription
1

Google

2

Microsoft

12

Web.de

13

Libero.it

Example: [1,2]
sender_emailstring
Example: "john@doe.com"
curl -i -X POST \
  https://api.instantly.ai/api/v2/inbox-placement-analytics/stats-by-date \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "test_id": "01959271-2fca-76df-a9bc-daf67ccf6b37"
  }'

Responses

Default Response

Bodyapplication/jsonArray [
timestamp_created_datestringrequired
Example: "2025-03-14T02:17:26.218Z"
spam_countnumberrequired
Example: 1
inbox_countnumberrequired
Example: 1
category_countnumberrequired
Example: 1
]
Response
application/json
[
  {
    "timestamp_created_date": "2025-03-14T02:17:26.218Z",
    "spam_count": 1,
    "inbox_count": 1,
    "category_count": 1
  }
]

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

API Key

Operations

Account Campaign Mapping

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing items

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Schemas