Skip to main content
POST
Email account metrics

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Body

application/json

Request body of get_email_accounts_metrics.

period
object
required

The metrics window [from, to).

Response

metrics success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
metrics
metrics
object
required
meta
object
required
applied_filters
object