RingCentral icon

RingCentral

Interact with RingCentral API - SMS, Voice, Fax, Meetings, and more

Analytics → Get Performance Data

AI-generated

Summary

Get Performance Data

Inputs

  • authMode (required) — Choose to use saved credentials or pass an access token dynamically
  • accessToken — The valid OAuth 2.0 Access Token (only when authMode is dynamic)
  • serverUrl — RingCentral API environment (only when authMode is dynamic)
  • timeFrom (required) — Start date/time for analytics data
  • timeTo (required) — End date/time for analytics data
  • groupBy — Grouping dimension: Company, CompanyHierarchy, Users, or Queues
  • allCalls — Include all calls counter
  • callsSegments — Include calls segments counter
  • abandonedCalls — Include abandoned calls counter
  • allCallsDuration — Include all calls duration timer
  • callsTalkTime — Include talk time timer
  • callsHoldTime — Include hold time timer

Output shape

Array of objects

Each object contains the group identifier (e.g., company ID, user ID, queue ID) and the requested performance metrics (call counts, durations, etc.) as numeric values.

Examples

Example 1: Fetch performance data for all users in the last month, including call count and talk time

Set timeFrom and timeTo to desired range, groupBy=Users, allCalls=true, callsTalkTime=true

Links

Discussion