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": [
    "<any>"
  ]
}

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Query Parameters

​
start_date
string

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

Example:

"2024-01-01"

​
end_date
string

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

Example:

"2024-01-31"

​
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
any[]

Analytics data grouped by phone numbers