Skip to main content
GET
/
stats
Get message statistics
curl --request GET \
  --url https://api.lettermint.co/v1/stats \
  --header 'Authorization: Bearer <token>'
{
  "from": "<string>",
  "to": "<string>",
  "totals": {
    "sent": 123,
    "delivered": 123,
    "hard_bounced": 123,
    "spam_complaints": 123,
    "opened": 123,
    "clicked": 123,
    "inbound": {
      "received": 123
    },
    "transactional": {
      "sent": 123,
      "hard_bounced": 123,
      "spam_complaints": 123
    },
    "broadcast": {
      "sent": 123,
      "hard_bounced": 123,
      "spam_complaints": 123
    }
  },
  "daily": [
    {
      "date": "<string>",
      "sent": 123,
      "delivered": 123,
      "hard_bounced": 123,
      "spam_complaints": 123,
      "opened": 123,
      "clicked": 123,
      "inbound": {
        "received": 123
      },
      "transactional": {
        "sent": 123,
        "hard_bounced": 123,
        "spam_complaints": 123
      },
      "broadcast": {
        "sent": 123,
        "hard_bounced": 123,
        "spam_complaints": 123
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Team API token. Find this in your team settings.

Query Parameters

from
string<date>
required
to
string<date>
required
project_id
string<uuid> | null

Response

StatsData

from
string
required
to
string
required
totals
StatsTotalsData · object
required
daily
StatsDailyData · object[]
required