Skip to main content
GET
cURL

Authorizations

API-Key
string
header
required

Account-scoped API key created in Settings. Operations declare the scopes they require. Available scopes:

  • RULES_READ: List and inspect automation rules for this inbox.
  • RULES_WRITE: Create, update, and delete automation rules for this inbox.
  • STATS_READ: Read aggregated inbox statistics for this inbox.
  • SENDERS_UNSUBSCRIBE: Unsubscribe from senders for this inbox.

Query Parameters

period
enum<string>
default:week
Available options:
day,
week,
month,
year
fromDate
number | null
toDate
number | null

Response

Successful response

result
object[]
required
allCount
number
required
inboxCount
number
required
readCount
number
required
sentCount
number
required