Skip to main content
GET
/
analytics
/
number-analytics
Get Number Analytics
curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/analytics/number-analytics \
  --header 'X-API-KEY: <x-api-key>'
{
  "number_analytics": "<array>"
}
Break analytics down by phone number. Use this to compare caller ID performance, monitor BYOT numbers, and identify numbers with poor pickup or completion rates.

​
Useful filters

  • start_date and end_date for reporting windows.
  • agent_id to compare numbers used by one assistant.
  • bulk_list_id to compare numbers inside one campaign.

​
How to act on results

If one number underperforms, check number assignment, telephony provider health, calling hours, and recipient region fit.

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Query Parameters

​
start_date
string
default:2025-09-25

Start date for analytics filter (YYYY-MM-DD format)

Example:

"2025-09-25"

​
end_date
string
default:2025-09-25

End date for analytics filter (YYYY-MM-DD format)

Example:

"2025-09-25"

​
agent_id
string

Filter by specific agent ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
bulk_list_id
string

Filter by specific bulk list/campaign ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
voicemail
boolean

Filter by voicemail status

Example:

false

Response

Number analytics retrieved successfully.

​
number_analytics
array

Analytics data grouped by phone numbers