---
title: "List inbox placement analytics"
method: GET
path: "/api/v2/inbox-placement-analytics"
tags: ["InboxPlacementAnalytics"]
---

# List inbox placement analytics

`GET /api/v2/inbox-placement-analytics`

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

## Query parameters

- `limit` integer
- `starting_after` string
- `test_id` string, uuid, required
- `date_from` string
- `date_to` string
- `recipient_geo` string
- `recipient_type` string
- `recipient_esp` string
- `sender_email` string

## Response `200`

The list of Inbox Placement Analytics

- object
  - `items` InboxPlacementAnalytics[], required — The list of Inbox Placement Analytics
    - `id` string, uuid, required — Unique identifier for the inbox placement analytics entry
    - `timestamp_created` string, required — Timestamp when the inbox placement analytics was created
    - `timestamp_created_date` string, required — Date when the inbox placement analytics was created
    - `organization_id` string, uuid, required — Organization ID
    - `test_id` string, uuid, required — Inbox Placement Test ID
    - `is_spam` boolean, nullable — Indicates if the email landed in spam (null if not determined). Only present when record_type is 2 (received).
    - `has_category` boolean, nullable — 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 — Email address of the sender
    - `sender_esp` 1 | 2 | 8 | 12 | 13, nullable — The sender ESP (Email Service Provider). Only present when record_type is 2 (received).
    - `recipient_email` string, nullable — Email address of the recipient
    - `recipient_esp` 1 | 2 | 8 | 12 | 13, nullable — The recipient ESP (Email Service Provider)
    - `recipient_geo` 1 | 2 | 3 | 4, nullable — The geographic location of the recipient
    - `recipient_type` 1 | 2, nullable — The type of recipient
    - `spf_pass` boolean, nullable — Indicates if the email passed SPF validation. Only present when record_type is 2 (received).
    - `dkim_pass` boolean, nullable — Indicates if the email passed DKIM validation. Only present when record_type is 2 (received).
    - `dmarc_pass` boolean, nullable — Indicates if the email passed DMARC validation. Only present when record_type is 2 (received).
    - `smtp_ip_blacklist_report` object, nullable — Blacklist report for the SMTP IP address. Only present when record_type is 2 (received).
    - `authentication_failure_results` object, nullable — Details of authentication failures for SPF, DKIM, and DMARC. Only present when record_type is 2 (received).
      - `authentication_results` string — Authentication results
      - `dkim_signature` string — DKIM signature
      - `received_spf` string — Received SPF
    - `record_type` 1 | 2, nullable — The type of record (sent or received)
  - `next_starting_after` string — 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

## Other responses

- `401` — This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked)
- `402` — This request cannot be fulfilled because the workspace does not have an active paid plan
- `404` — The requested resource was not found
- `429` — You have exceeded the rate limit. Please check the rate limit docs for more information.

---

[API](https://skmtc.net/instantly/apis/api-explorer.md) · [All operations](https://skmtc.net/instantly/apis/api-explorer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instantly/api-explorer/revisions/378d1e253fe7/schema)
