Introduction to the RingCentral Analytics API

Last updated: 2021-08-20 Contributors Byrne Reese
Edit this page

Please be advised: the RingCentral MVP Analytics API is currently in beta, and is subject to change.

Getting Started with Analytics

The RingCentral Analytics API gives developers access to the data and metrics necessary to help their organizations obtain a deeper understanding of how their team uses RingCentral's voice and telephony service.

We invite all developers to try out our Analytics API by writing a simple app to access key call performance metrics in almost no time at all. Get started using a Quick Start : in any of the following languages:

C# »

Requesting access to the beta

The Analytics API is currently in a private beta. We have made the documentation available to help developers determine for themselves whether this API would be of value to them. To request access to the beta so that you can use this API, click the button below.

Request access to the Analytics API Beta »

Important notes about the beta

The Analytics API is only available in our production enviornment, and cannot yet be called in our sandbox environment where most development occurs. Therefore you will need production credentials to use this API. To obtain production credentials, please submit a help ticket to request your application to be graduated to production.

Learn more about the Call Performance Analytics API

Access metrics to measure your team's performance

Call Performance Reports is a historical call analytics offering for RingCentral MVP customers to help managers gain a comprehensive understanding of their team’s performance whether they are set up on call queues, user groups or as individual users. This product provides direct access to granular data behind our Analytics Portal via an API. There are two primary metrics summarized and accessible through this API:

  • Calls - an aggregation of the number of calls a person is on
  • Time Spent - an aggregation of time spent on calls

The above metrics can be broken down even further for more detailed analyis.

Learn more about Call Performance Data Guide »

Frequently Asked Questions

How do I get started ?

There are three ways to get started:

  1. Follow the step-by-step Quick Start in order to build a command-line application or test the API using Postman.

  2. Read the API Reference to understand the various APIs' definition, HTTP Request and Response objects.

  3. Dive into the sample application and use that as a springboard for your custom application.

Is there an SDK for my favorite programming language?

Yes, RingCentral offers developers a number of SDKs for the most popular programming languages.

During our beta however, Java and C# programmers will need to call Analytics API endpoints directly. When this API is made available publicly, our Java and C# SDKs will be updated as well.

What permission does my application need to have?

Currently, the Call Performance API doesn't require any particular permission from your application so it should work as long as you have the credentials for production enviornment.