---
title: "A tenant's email counts and sending ramp"
method: GET
path: "/tenants/{id}/stats"
tags: ["Tenants"]
---

# A tenant's email counts and sending ramp

`GET /tenants/{id}/stats`

## Request

- Base URL: `https://api.groundmail.dev`
- URL: `https://api.groundmail.dev/tenants/{id}/stats`
- Auth: HTTP bearer

Counts and rates for the tenant's emails created in the last `days`, and its sending ramp today. A key limited to one tenant can read its own tenant's stats.

## Query parameters

- `days` integer

## Response `200`

The tenant's stats

- TenantStatsResponse
  - `tenant` string, required: The tenant's `external_id`.
  - `stats` TenantStats, required
    - `object` 'tenant_stats'
    - `days` integer
    - `from` string, date-time
    - `total` integer
    - `queued` integer
    - `scheduled` integer
    - `sent` integer
    - `delivered` integer
    - `bounced` integer
    - `complained` integer
    - `failed` integer
    - `suppressed` integer
    - `opened` integer
    - `clicked` integer
    - `bounce_rate` number
    - `complaint_rate` number
  - `ramp` TenantRamp: The tenant's sending ramp today. Each new tenant starts at 1,000 product and 3,000 transactional recipients per UTC day, and the limit doubles each day it used at least half of it with bounces under 2% and complaints under 0.1%.
    - `object` 'tenant_ramp', required
    - `active` boolean, required: `false` when no ramp limit applies: the tenant has not sent yet, its ramp is complete, or support lifted it.
    - `stage` integer, nullable, required: Current stage while the ramp is active.
    - `daily_limit` object, nullable, required: Today's recipient limits per stream; `null` when the ramp is not active.
      - `transactional` integer, nullable
      - `product` integer, nullable
    - `used_today` object, required
      - `transactional` integer
      - `product` integer
    - `completed` boolean, required
    - `resets_at` string, date-time, required: The next 00:00 UTC.

## Other responses

- `400`: `days` out of range
- `401`: Missing or invalid API key
- `404`: Tenant not found

---

[API](https://skmtc.dev/groundmail/apis/groundmail-api.md) · [All operations](https://skmtc.dev/groundmail/apis/groundmail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/groundmail/apis/groundmail-api/revisions/479821c9fecf?raw)
