Stats

Get message statistics

GET

https://api.lettermint.co/v1

/stats

Bearer

Returns aggregate message statistics for the specified date range. Provide a project_id to get per-project stats with transactional/broadcast breakdown. Without project_id, returns team-wide totals from team_message_stats. Maximum date range is 90 days.

Get message statistics › query Parameters

from

string · required

Start date (Y-m-d)

to

string · required

End date (Y-m-d, max 90 days from from)

from

string · date · required

to

string · date · required

project_id

string

Optional project UUID for project-scoped stats with transactional/broadcast breakdown

include_machine

boolean

Include machine/privacy/security tracking observations in open and click totals

project_id

string | null · uuid

include_machine

boolean

Default: false

Get message statistics › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message statistics › Responses

StatsData

StatsData

from

string · required

to

string · required

StatsTotalsData · required

StatsDailyData[] · required

GET/stats

curl 'https://api.lettermint.co/v1/stats?from=<string>&to=<string>&from=<string>&to=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "from": "from",
  "to": "to",
  "totals": {
    "sent": 0,
    "delivered": 0,
    "hard_bounced": 0,
    "spam_complaints": 0,
    "opened": 0,
    "clicked": 0,
    "inbound": {
      "received": 0
    },
    "transactional": {
      "sent": 0,
      "hard_bounced": 0,
      "spam_complaints": 0
    },
    "broadcast": {
      "sent": 0,
      "hard_bounced": 0,
      "spam_complaints": 0
    },
    "effective_opened": 0,
    "machine_opened": 0,
    "machine_clicked": 0
  },
  "daily": [
    {
      "date": "date",
      "sent": 0,
      "delivered": 0,
      "hard_bounced": 0,
      "spam_complaints": 0,
      "opened": 0,
      "clicked": 0,
      "inbound": {
        "received": 0
      },
      "transactional": {
        "sent": 0,
        "hard_bounced": 0,
        "spam_complaints": 0
      },
      "broadcast": {
        "sent": 0,
        "hard_bounced": 0,
        "spam_complaints": 0
      },
      "effective_opened": 0,
      "machine_opened": 0,
      "machine_clicked": 0
    }
  ]
}

json

application/json

Team Domain

Lettermint Team API

Stats

Download schema

Get message statistics

GET

https://api.lettermint.co/v1

/stats

Bearer

Get message statistics › query Parameters

from

string · required

Start date (Y-m-d)

to

string · required

End date (Y-m-d, max 90 days from from)

from

string · date · required

to

string · date · required

project_id

string

Optional project UUID for project-scoped stats with transactional/broadcast breakdown

include_machine

boolean

Include machine/privacy/security tracking observations in open and click totals

project_id

string | null · uuid

include_machine

boolean

Default: false

Get message statistics › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message statistics › Responses

StatsData

StatsData

from

string · required

to

string · required

StatsTotalsData · required

StatsDailyData[] · required

GET/stats

curl 'https://api.lettermint.co/v1/stats?from=<string>&to=<string>&from=<string>&to=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "from": "from",
  "to": "to",
  "totals": {
    "sent": 0,
    "delivered": 0,
    "hard_bounced": 0,
    "spam_complaints": 0,
    "opened": 0,
    "clicked": 0,
    "inbound": {
      "received": 0
    },
    "transactional": {
      "sent": 0,
      "hard_bounced": 0,
      "spam_complaints": 0
    },
    "broadcast": {
      "sent": 0,
      "hard_bounced": 0,
      "spam_complaints": 0
    },
    "effective_opened": 0,
    "machine_opened": 0,
    "machine_clicked": 0
  },
  "daily": [
    {
      "date": "date",
      "sent": 0,
      "delivered": 0,
      "hard_bounced": 0,
      "spam_complaints": 0,
      "opened": 0,
      "clicked": 0,
      "inbound": {
        "received": 0
      },
      "transactional": {
        "sent": 0,
        "hard_bounced": 0,
        "spam_complaints": 0
      },
      "broadcast": {
        "sent": 0,
        "hard_bounced": 0,
        "spam_complaints": 0
      },
      "effective_opened": 0,
      "machine_opened": 0,
      "machine_clicked": 0
    }
  ]
}

json

application/json

Team Domain