Dashboard counts
GET/v1/console/overview
Message counts by channel, verification conversion, balance, webhook health and what remains to set up, in one request. Requires messages:read.
Parameters
| Name | In | Description |
|---|---|---|
| hours | query |
Example
curl https://api.woyra.io/v1/console/overview \
-H "Authorization: Bearer $WOYRA_KEY"Response
200 The overview.
| Field | Type | Description |
|---|---|---|
| object | "overview" | |
| window_hours | integer | |
| messages | ChannelCounts | |
| channels | array of ChannelCounts | |
| verify | object | |
| verify.started | integer | |
| verify.verified | integer | |
| verify.conversion_rate | number | |
| balance | Balance | |
| webhooks | object | |
| webhooks.endpoints | integer | |
| webhooks.quarantined | integer | |
| webhooks.pending_deliveries | integer | |
| webhooks.failed_deliveries | integer | |
| domains | object | |
| domains.total | integer | |
| domains.verified | integer | |
| setup | object | What the account has not done yet. |
| setup.email_verified | boolean | |
| setup.has_live_key | boolean | |
| setup.has_verified_domain | boolean | |
| setup.has_sent_message | boolean | |
| setup.has_balance | boolean | |
| setup.has_webhook | boolean | |
| setup.mfa_enabled | boolean |
Also in Console
- POST /v1/auth/signup — Create an account and sign in
- POST /v1/auth/login — Sign in with email and password
- POST /v1/auth/logout — End the session
- GET /v1/auth/config — What a sign-in page needs before anyone signs in
- GET /v1/auth/me — The signed-in user, account and MFA state
- POST /v1/auth/mfa/verify — Finish signing in with a TOTP code or a recovery code
- POST /v1/auth/passkeys/login/begin — Start signing in with a passkey
- POST /v1/auth/passkeys/login/finish — Finish signing in with a passkey
- GET /v1/auth/passkeys — The signed-in user's passkeys
- POST /v1/auth/passkeys/register/begin — Start adding a passkey
- POST /v1/auth/passkeys/register/finish — Finish adding a passkey
- DELETE /v1/auth/passkeys/{id} — Remove a passkey
- POST /v1/auth/recovery_codes — Make a fresh set of recovery codes
- POST /v1/auth/mfa/enrol — Start TOTP enrolment
- POST /v1/auth/mfa/confirm — Confirm TOTP enrolment with a code
- DELETE /v1/auth/mfa — Disable TOTP
- POST /v1/auth/verify-email — Confirm an email address from its link
- POST /v1/auth/resend-verification — Send the verification email again
- POST /v1/auth/forgot-password — Request a password reset link
- POST /v1/auth/reset-password — Set a new password from a reset link
- POST /v1/auth/change-password — Change the password while signed in
- GET /v1/auth/invites/{token} — Describe an invitation before accepting it
- POST /v1/auth/invites/accept — Accept an invitation and sign in
- GET /v1/console/analytics — Daily series and the route view
- GET /v1/console/stream — Live message events
- GET /v1/audit_events — The account's audit trail