tenantEmailAnalytics

Requires at least one of the permissions settings:email:read or settings:tenant:read.

Returns the organization's quote email statistics: emails sent, delivered, opened, clicked and replied to, with delivery, open, click and reply rates and the average response time. Rates are null until there is data. Requires permission to read email or tenant settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query TenantEmailAnalytics {
  tenantEmailAnalytics {
    avgResponseTimeHours
    clickRate
    deliveryRate
    openRate
    replyRate
    totalEmailsClicked
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TenantEmailAnalytics {\n  tenantEmailAnalytics {\n    avgResponseTimeHours\n    clickRate\n    deliveryRate\n    openRate\n    replyRate\n    totalEmailsClicked\n  }\n}"
}
EOF

Response:

{
  "data": {
    "tenantEmailAnalytics": {
      "avgResponseTimeHours": 0,
      "clickRate": 0,
      "deliveryRate": 0,
      "openRate": 0,
      "replyRate": 0,
      "totalEmailsClicked": 0
    }
  }
}

tenantEmailAnalytics: TenantEmailAnalytics!

Type

TenantEmailAnalytics object

Email engagement across all of your organization's document emails.