Getting started (Insights Stats API)

After reading through this guide, check out the API Reference within the Explorer section to see all available API requests, and use the Explorer to test calls in real-time with your own data.

To start using the Insights Stats API you must have completed the following tasks:

• Sign up for a Vonage Contact Center (VCC) account. Find more information on how to do this at Vonage | Cloud Contact Center.
• Set up a working interaction plan in which interactions are delivered to your agents through an Automatic Call Distributor or Universal Contact Distributor. For information about setting up interactions plans and using Vonage Contact Center to make and receive interactions, go to Vonage Contact Center Product Documentation.
• Get your client credentials from Vonage Contact Center. For information about getting your client credentials, see Getting a bearer access token in How to authenticate with a Vonage Contact Center (VCC) API.
• Use your client credentials to get your bearer access token. You must use your bearer access token to send API requests. For information about getting your client credentials, see Using a bearer access token in How to authenticate with a Vonage Contact Center (VCC) API.
• The data returned over the API is specific to your account. Some of the features described in this documentation may not relate to your account settings or package.

The root URL for the Insights Stats API is https://***.api.cc.vonage.com/stats, where *** represents a regional subdomain. 

Add the resource name to the URL to form the endpoint you need to access the resource and its fields. For example, https://***.api.cc.vonage.com/stats/interactions provides access to the interactions resource and its fields.