Get sending account statistics

{ "meta": { "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx" }, "data": { "total": 12, "active": 8, "inactive": 3, "error": 1, "pending": 0, "by_type": { "smtp": 6, "gmail_api": 4, "outlook_api": 2, "amazon_ses": 1 }, "by_status": { "active": 8, "inactive": 3, "error": 1, "pending": 0 } } }

Authorizations

Authorization

string

header

required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Response

Sending account statistics

enum<boolean>

required

Available options:

true

meta

object

required

Hide child attributes

meta.request_id

string

required

Example:

"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"

data

object

required

Hide child attributes

data.total

number

required

Total number of sending accounts

Example:

12

data.active

number

required

Accounts with status 'active'

Example:

8

data.inactive

number

required

Accounts with status 'inactive'

Example:

3

data.error

number

required

Accounts with status 'error'

Example:

1

data.pending

number

required

Accounts with status 'pending'

Example:

0

data.by_type

object

required

Hide child attributes

data.by_type.smtp

number

required

Number of SMTP accounts

Example:

6

data.by_type.gmail_api

number

required

Number of Gmail API accounts

Example:

4

data.by_type.outlook_api

number

required

Number of Outlook API accounts

Example:

2

data.by_type.amazon_ses

number

required

Number of shared Amazon SES accounts

Example:

1

data.by_status

object

required

Hide child attributes

data.by_status.active

number

required

Example:

8

data.by_status.inactive

number

required

Example:

3

data.by_status.error

number

required

Example:

1

data.by_status.pending

number

required

Example:

0

Documentation Index

Authorizations

Response