Skip to main content
GET
Get Platform Analytics

Notes

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Query Parameters

start_date
string

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

Example:

"2025-09-25"

end_date
string

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