RingCentral icon

RingCentral

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

Analytics → Get Aggregated Data

AI-generated

Summary

Retrieve aggregated call analytics from RingCentral for a specified time range, with optional grouping and counter/timer configurations.

Inputs

  • authMode — Choose to use saved credentials or pass an access token dynamically. Defaults to saved credentials if omitted.
  • accessToken — The valid OAuth 2.0 Access Token. Required when authMode is set to dynamic.
  • serverUrl — The RingCentral API environment. Defaults to production unless authMode is dynamic.
  • timeSettings (required) — Time range for analytics data. Contains timeFrom and timeTo date-time values.
  • grouping — Grouping dimension for analytics data. Options: Company, Company Hierarchy, Users, Queues. Defaults to Company.
  • additionalOptions — Optional counters and timers to include in the response. Contains nested boolean flags for specific metrics.

Output shape

object

Returns aggregated analytics data from the RingCentral API, including requested counters (allCalls, callsSegments, abandonedCalls) and timers (allCallsDuration, callsTalkTime, callsHoldTime), grouped by the specified grouping dimension for the configured time range.

Links

Discussion