WoyraDocs
Get an API key

Dashboard counts

GET/v1/console/overview

Console · Requires an API key

Message counts by channel, verification conversion, balance, webhook health and what remains to set up, in one request. Requires messages:read.

Parameters

NameInDescription
hoursquery

Example

curl https://api.woyra.io/v1/console/overview \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 The overview.

FieldTypeDescription
object"overview"
window_hoursinteger
messagesChannelCounts
channelsarray of ChannelCounts
verifyobject
verify.startedinteger
verify.verifiedinteger
verify.conversion_ratenumber
balanceBalance
webhooksobject
webhooks.endpointsinteger
webhooks.quarantinedinteger
webhooks.pending_deliveriesinteger
webhooks.failed_deliveriesinteger
domainsobject
domains.totalinteger
domains.verifiedinteger
setupobjectWhat the account has not done yet.
setup.email_verifiedboolean
setup.has_live_keyboolean
setup.has_verified_domainboolean
setup.has_sent_messageboolean
setup.has_balanceboolean
setup.has_webhookboolean
setup.mfa_enabledboolean

Also in Console