Skip to main content
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: <x-api-key>'
{
  "performance_metrics": {},
  "metrics_summary": {},
  "cached": true
}
Return high-level platform analytics for calls in the workspace. Use this endpoint for overview dashboards and executive summaries.

​
Common filters

  • start_date and end_date for the reporting period.
  • agent_id for one assistant.
  • bulk_list_id for one campaign.
  • voicemail when voicemail-heavy traffic should be included or separated.

​
Developer guidance

Use this endpoint for top-level numbers, then use drill-down analytics or call history when a user clicks into a specific campaign, number, or status bucket.

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

Platform analytics retrieved successfully.

​
performance_metrics
object

Performance metrics by different categories

​
metrics_summary
object

Summary of key metrics

​
cached
boolean

Whether the response was served from cache