Phone Numbers
Get number health dashboard
Returns the health & analytics dashboard for one of your numbers: current status, spam flag, and call metrics over the selected window (total and answered calls, answer rate, minutes, average duration) plus a per-period time series of snapshots.
get/api/v1/account/{auth_id}/numbers/{e164}/health
Request
- Base URLhttps://api.vobiz.ai
- AuthAPI key in header X-Auth-ID and API key in header X-Auth-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
auth_idstring required
Example:MA_XXXXXX
Your account Auth ID
e164string required
Example:%2B919876543210
The number in E.164, URL-encoded (use %2B instead of +).
Query parameters
granularity'daily' | 'hourly'
Snapshot granularity.
daysinteger
Example:30
Size of the window (in days) for the summary and snapshots.
Response
Number health dashboard
Example response
{
"e164": "+919876543210",
"status": "active",
"usage_status": "unrated",
"granularity": "daily",
"summary": {
"period_days": 30
},
"snapshots": [
{
"id": "bd41d44b-7217-4a78-9261-588fb1b41c25",
"ts": "2026-06-04T00:00:00Z"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.