Ring Group Summary

📘 Updated Endpoint

The Ring Group Member Summary and Ring Group Summary are dedicated endpoints to replace the previous Ring Group & Ring Group Member Summary endpoint which served both purposes

📘

Note: This API provides access to data from the past 2 years only in accordance with Analytics for Work data compliance policies; queries spanning more than 2 years will return only the most recent 2 years of data, and queries outside this range will return no results

📘 You will need a working API key to begin

You can generate API credentials from How to get API Keys

The 8x8-api-key will be the Key generated. For Work Analytics the Secret from Admin Console is not required.

Use the following base URL during this process:

https://api.8x8.com/analytics/work

1. Authenticate to retrieve access token

You will use your API key combined with the user credentials of a user with permission and access to Work Analytics to authenticate, this user does not need to be the one who generated the API credentials

🚧 User must access Analytics at least once via browser

The users credentials will not be able to leverage the API until they have used Work Analytics via browser at least once

Parameters

Method: POST

Headers

Name	Required	Description	Example
8x8-apikey	✓	The 8x8-api key provided	test_key_kjdfidj238jf9123df221
Content-Type	✓	Set content type to form-urlencoded	application/x-www-form-urlencoded

Body

Name	Required	Description	Example
username	✓	The 8x8 username of a user with Work Analytics access privileges	someuser@acme.fakeco
password	✓	The 8x8 password of the user with Work Analytics access privileges	Rrnp5QBW6dTbx^TP

Authentication Request

curl --location --request POST 'https://api.8x8.com/analytics/work/v1/oauth/token' \
--header '8x8-apikey: {8x8-apikey input here}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username={8x8 username of user input here}' \
--data-urlencode 'password={8x8 password of user input here}'

Authentication Response

Response

{
    "access_token": "eyJhbGciOiJSUzI1NiJ9.yyyyyyyyy.zzzzzzzzzzzzzzzzzz",
    "token_type": "bearer",
    "expires_in": 1800

Outputs For Next Step:

access_token
expires_in

The token will expire in the number of seconds specified in expires_in.

The following steps will use the access_token as a Bearer Token form of authentication. This takes the form of the

Authorization header being set to Bearer access_token (Space between Bearer and the access_token)

2. Run Ring Group Summary

This will return a summary for all of the Ring Groups in the specified PBXs for the duration specified.

Parameters

Method: GET

Headers

Name	Required	Description	Example
Authorization	✓	Pass the access_token returned from the authentication request as a Bearer token `Bearer {access_token}`	Bearer eyJhbGciOiJSUzI1NiJ9.yyyyyyyyy.zzzzzzzzzzzzzzzzzz

Path

Name	Required	Description	Example
version	✓	The current version for ring group summary is v2	v2

Query

Name	Required	Description	Example
pbxId	✓	Pass the pbxId (PBX Name) of the requested pbx or comma separated list of pbxIds or `allpbxes` for all of the pbxs in the customer account. PBX names can be found here in Admin Console	acmecorp,acmecorp2
startTime	✓	The interval start time for CDR searches - the format is YYYY-MM-DD HH:MM:SS.	2022-10-20 08:30:00
endTime	✓	The interval end time for CDR searches - the format is YYYY-MM-DD HH:MM:SS.	2022-10-20 19:00:00
timeZone	✓	IANA Time Zones. Examples America/New_York, Europe/London Wikipedia Time Zone List	America/New_York