Get Number Health Dashboard

GET

api

account

{auth_id}

numbers

{e164}

health

Get number health dashboard

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{auth_id}/numbers/{e164}/health \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/account/{auth_id}/numbers/{e164}/health"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/account/{auth_id}/numbers/{e164}/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "e164": "+919876543210",
  "status": "active",
  "usage_status": "unrated",
  "is_spam": false,
  "granularity": "daily",
  "summary": {
    "period_days": 30,
    "total_calls": 0,
    "answered_calls": 0,
    "answer_rate": 0,
    "total_minutes": 0,
    "avg_duration": 0
  },
  "snapshots": [
    {
      "id": "bd41d44b-7217-4a78-9261-588fb1b41c25",
      "ts": "2026-06-04T00:00:00Z",
      "total_calls": 0,
      "answered_calls": 0,
      "failed_calls": 0,
      "answer_rate": 0,
      "total_duration": 0,
      "avg_duration": 0,
      "total_minutes": 0
    }
  ]
}

{
  "api_id": "<string>",
  "error": "<string>",
  "message": "<string>"
}

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

e164

string

required

The number in E.164, URL-encoded (use %2B instead of +).

Example:

"%2B919876543210"

Query Parameters

granularity

enum<string>

default:daily

Snapshot granularity.

Available options:

daily,

hourly

days

integer

default:30

Size of the window (in days) for the summary and snapshots.

Example:

30

Response

Number health dashboard

e164

string

Example:

"+919876543210"

status

string

Example:

"active"

usage_status

string

Reputation/usage rating for the number.

Example:

"unrated"

is_spam

boolean

Example:

false

granularity

string

Example:

"daily"

summary

object

Show child attributes

snapshots

object[]

Show child attributes

Get number health dashboard

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{auth_id}/numbers/{e164}/health \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/account/{auth_id}/numbers/{e164}/health"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/account/{auth_id}/numbers/{e164}/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "e164": "+919876543210",
  "status": "active",
  "usage_status": "unrated",
  "is_spam": false,
  "granularity": "daily",
  "summary": {
    "period_days": 30,
    "total_calls": 0,
    "answered_calls": 0,
    "answer_rate": 0,
    "total_minutes": 0,
    "avg_duration": 0
  },
  "snapshots": [
    {
      "id": "bd41d44b-7217-4a78-9261-588fb1b41c25",
      "ts": "2026-06-04T00:00:00Z",
      "total_calls": 0,
      "answered_calls": 0,
      "failed_calls": 0,
      "answer_rate": 0,
      "total_duration": 0,
      "avg_duration": 0,
      "total_minutes": 0
    }
  ]
}

{
  "api_id": "<string>",
  "error": "<string>",
  "message": "<string>"
}