---
title: "Get inbox placement analytics"
method: GET
path: "/api/v1/analytics/inbox-placement"
tags: ["Analytics"]
---

# Get inbox placement analytics

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

## Request

- Base URL: `https://api.aerosend.io`
- URL: `https://api.aerosend.io/api/v1/analytics/inbox-placement`
- Auth: API key in header `X-API-Key`

Returns inbox placement analytics for the authenticated client.

The payload includes overall send/inbox/spam metrics, Google and Outlook totals, overall
ESP breakdown, and **all** sender domains from that test (each with a nested ESP breakdown).
There is no pagination - the full domain list is returned in a single response.

## Response `200`

Successfully retrieved inbox placement analytics

- InboxPlacementAnalyticsApiResponse
  - `success` boolean: Success flag
  - `data` InboxPlacementAnalytics: Inbox placement test analytics for the authenticated client
    - `test_run_at` string: When the test was run
    - `total_emails_sent` integer: Total emails sent in the test
    - `inbox_count` integer: Emails delivered to inbox
    - `spam_count` integer: Emails delivered to spam
    - `inbox_percentage` number: Overall inbox rate as a percentage
    - `spam_percentage` number: Overall spam rate as a percentage
    - `google_total_sent` integer: Total emails sent to Google / Google Workspace seed inboxes
    - `outlook_total_sent` integer: Total emails sent to Outlook / Microsoft 365 seed inboxes
    - `overall_esp_breakdown` EspBreakdown[]: Overall metrics grouped by email service provider
      - `esp_name` 'Gmail' | 'Google Workspace' | 'Outlook' | 'Microsoft 365' | 'Yahoo Mail' | 'Zoho Mail' | 'Other': Email service provider name
      - `total_emails` integer: Total emails sent to this ESP
      - `inbox_count` integer: Emails delivered to inbox
      - `spam_count` integer: Emails delivered to spam
      - `inbox_percentage` number: Inbox rate as a percentage of total emails
    - `domain_breakdown` DomainAnalytics[]: Per-domain metrics, including nested ESP breakdown. All domains from the test are returned.
      - `sender_domain` string: Sender domain
      - `total_emails` integer: Total emails sent from this domain
      - `inbox_count` integer: Emails delivered to inbox
      - `spam_count` integer: Emails delivered to spam
      - `inbox_percentage` number: Inbox rate as a percentage of total emails
      - `esp_breakdown` EspBreakdown[]: Per-ESP metrics for this domain
        - `esp_name` 'Gmail' | 'Google Workspace' | 'Outlook' | 'Microsoft 365' | 'Yahoo Mail' | 'Zoho Mail' | 'Other': Email service provider name
        - `total_emails` integer: Total emails sent to this ESP
        - `inbox_count` integer: Emails delivered to inbox
        - `spam_count` integer: Emails delivered to spam
        - `inbox_percentage` number: Inbox rate as a percentage of total emails
  - `timestamp` string: Response timestamp

## Other responses

- `401`: Unauthorized - Invalid or expired API key
- `404`: No completed inbox placement test with analytics exists for this client
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/aerosend/apis/aerosend-developer-api.md) · [All operations](https://skmtc.dev/aerosend/apis/aerosend-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aerosend/apis/aerosend-developer-api/revisions/9828eeb89b1f?raw)