Skip to main content
GET
cURL
Guide: Metrics

Authorizations

Authorization
string
header
required

Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes verify:check, verify:send (includes verify:check), notifications:read, notifications:send (includes notifications:read), email:read, email:send (includes email:read), email:manage (includes email:send), webhooks:manage, email:inbound, notifications:templates (includes notifications:read), chat:menus, chat:attendant. No key made on the API keys page holds notifications:templates, full access included: the three template writes answer such a key 403 insufficient_scope. A connected app's key holds it. Nor chat:menus: the five conversation menu operations answer such a key 403 insufficient_scope, and a connected app's key holds it once the client approved it. Nor chat:attendant: the five auto-attendant operations answer such a key 403 insufficient_scope too, and a connected app's key holds it once the client approved it. email:manage and webhooks:manage are held only by a key someone chose them for: a full-access key, old or new, never holds them. email:inbound, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 insufficient_scope and names the scope it needs in the WWW-Authenticate response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.

Query Parameters

from
string

The first Riyadh day, YYYY-MM-DD; 30 days before to by default.

to
string

The last Riyadh day, YYYY-MM-DD; today by default. At most 366 days after from.

granularity
string

day (the default), week (weeks start on Sunday) or month.

domain
string

One domain of the application, by id or name (removed ones included).

timezone
string

Only Asia/Riyadh: metrics are counted on Riyadh days.

Response

The figures

from
string
to
string
timezone
string
granularity
string
domain
string | null
totals
object
rates
object
data
object[]