Get Platform Analytics
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/analytics/platform-analytics \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/analytics/platform-analytics"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/analytics/platform-analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"performance_metrics": {},
"metrics_summary": {},
"cached": true
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}Get Platform Analytics
Get workspace-level call metrics for a date range, filtered by agent, campaign or voicemail, for overview dashboards and reports built outside Ringg AI.
GET
/
analytics
/
platform-analytics
Get Platform Analytics
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/analytics/platform-analytics \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/analytics/platform-analytics"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/analytics/platform-analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"performance_metrics": {},
"metrics_summary": {},
"cached": true
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}Notes
- For one campaign in detail, call drill-down analytics; for call-level rows, call history.
Authorizations
Headers
(Required) Your Ringg AI API key.
Example:
"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Query Parameters
Start date for analytics filter (YYYY-MM-DD format)
Example:
"2025-09-25"
End date for analytics filter (YYYY-MM-DD format)
Example:
"2025-09-25"
Filter by specific agent ID
Example:
"123e4567-e89b-12d3-a456-426614174000"
Filter by specific bulk list/campaign ID
Example:
"123e4567-e89b-12d3-a456-426614174000"
Filter by voicemail status
Example:
false
Was this page helpful?