---
title: "Get number health dashboard"
method: GET
path: "/api/v1/account/{auth_id}/numbers/{e164}/health"
tags: ["Phone Numbers"]
---

# Get number health dashboard

`GET /api/v1/account/{auth_id}/numbers/{e164}/health`

## Request

- Base URL: `https://api.vobiz.ai`
- URL: `https://api.vobiz.ai/api/v1/account/{auth_id}/numbers/{e164}/health`
- Auth: API key in header `X-Auth-ID` and API key in header `X-Auth-Token`
- TypeScript: <https://skmtc.dev/vobiz/apis/vobiz-api/docs/api/v1/account/:auth_id/numbers/:e164/health/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `auth_id` string, required
- `e164` string, required

## Query parameters

- `granularity` 'daily' | 'hourly'
- `days` integer

## Response `200`

Number health dashboard

- object
  - `e164` string
  - `status` string
  - `usage_status` string: Reputation/usage rating for the number.
  - `is_spam` boolean
  - `granularity` string
  - `summary` object
    - `period_days` integer
    - `total_calls` integer
    - `answered_calls` integer
    - `answer_rate` number
    - `total_minutes` number
    - `avg_duration` number
  - `snapshots` object[]
    - `id` string
    - `ts` string, date-time
    - `total_calls` integer
    - `answered_calls` integer
    - `failed_calls` integer
    - `answer_rate` number
    - `total_duration` number
    - `avg_duration` number
    - `total_minutes` number

## Other responses

- `404`: Number not found

---

[API](https://skmtc.dev/vobiz/apis/vobiz-api.md) - [All operations](https://skmtc.dev/vobiz/apis/vobiz-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vobiz/apis/vobiz-api/revisions/863f08cd6737?raw)