XCaaS Analytics & ContentXCaaS Actions & Events8x8 ConnectJaaSWe're Hiring!
Guides

Ring Group & Ring Group Member Summaries

Summary information on Ring Group performance and on the performance of Ring Group Members.

Suggest Edits

🚧

Updated Endpoints Available

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

You will need a working API key to begin

📘

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

NameRequiredDescriptionExample
8x8-apikey✓The 8x8-api key providedtest_key_kjdfidj238jf9123df221
Content-Type✓Set content type to form-urlencodedapplication/x-www-form-urlencoded

Body

NameRequiredDescriptionExample
username✓The 8x8 username of a user with Work Analytics access privileges[email protected]
password✓The 8x8 password of the user with Work Analytics access privilegesRrnp5QBW6dTbx^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)

2a. 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

NameRequiredDescriptionExample
8x8-apikey✓The 8x8-api key providedtest_key_kjdfidj238jf9123df221
Authorization✓Pass the access_token returned from the authentication request as a Bearer token Bearer {access_token}Bearer eyJhbGciOiJSUzI1NiJ9.yyyyyyyyy.zzzzzzzzzzzzzzzzzz

Path

NameRequiredDescriptionExample
version✓The current version for ring group summary is v2v2

Query

NameRequiredDescriptionExample
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 accountacmecorp,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 ListAmerica/New_York

Ring Group Summary Request

📘

Try out the Ring Group Summary

Which group has the least missed calls, lets find out @ Ring Group Summary Reference

curl --location --request GET 'https://api.8x8.com/analytics/work/v{version}/rgsum?pbxId={pbxId here}&startTime=2022-02-03 00:00:00&endTime=2022-02-03 10:00:00&timeZone=America/New_York' \
--header 'Authorization: Bearer {access_token here}' \
--header '8x8-apikey: {8x8-apikey input here}'

Ring Group Summary Response

For details on the company summary metrics please refer to Ring Group Summary Glossary

📘

Durations are in milliseconds

[
    {
        "pbxId": "acmecorp",
        "site": "East",
        "name": "Marketing",
        "extension": "100027",
        "totalMembers": 0,
        "totalInbound": 1,
        "totalAbandoned": 1,
        "totalAnswered": 0,
        "totalMissed": 1,
        "totalCallsToVM": 0,
        "totalAdvanced": 0,
        "totalRgTime": 5475,
        "totalTalkTime": 0,
        "totalCalls": 1,
        "avgAbandonedTime": 5475,
        "avgRgTime": 5475,
        "avgRingTime": 283,
        "avgTalkTime": 0,
        "totalAbandonedTime": 5475,
        "totalRingTime": 283
    },
    {
        "pbxId": "acmecorp2",
        "site": "West",
        "name": "Sales",
        "extension": "100055",
        "totalMembers": 0,
        "totalInbound": 12,
        "totalAbandoned": 0,
        "totalAnswered": 0,
        "totalMissed": 12,
        "totalCallsToVM": 12,
        "totalAdvanced": 0,
        "totalRgTime": 0,
        "totalTalkTime": 0,
        "totalCalls": 12,
        "avgAbandonedTime": 0,
        "avgRgTime": 0,
        "avgRingTime": 0,
        "avgTalkTime": 0,
        "totalAbandonedTime": 0,
        "totalRingTime": 0
    }
  ]

2b. Run Ring Group Member Summary

This will return a summary each member of each Ring Group in the specified PBXs for the duration specified.

📘

Ring Group Member Summary Reference

You can check out Ring Group Member Summary Reference but you won't be able to try it yet.

Parameters

Method: GET

Headers

NameRequiredDescriptionExample
8x8-apikey✓The 8x8-api key providedtest_key_kjdfidj238jf9123df221
Authorization✓Pass the access_token returned from the authentication request as a Bearer token Bearer {access_token}Bearer eyJhbGciOiJSUzI1NiJ9.yyyyyyyyy.zzzzzzzzzzzzzzzzzz

Path

NameRequiredDescriptionExample
version✓The current version for ring group summary is v2v2

Query

NameRequiredDescriptionExample
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 accountacmecorp,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 ListAmerica/New_York
extId✓The extension number of the ring group. Only a single ring group extension can be specified.100169
collapse☐This true or false value determines whether to collapse ring group member summaries into a single summary, even if the user information has changed during the date range selected; otherwise a distinct summary will be created for each distinct set of member data. Default is truetrue

Ring Group Member Summary Request

📘

Try out the Ring Group Member Summary

How does average talk time compare across users? Lets find out @ Ring Group Member Summary Reference

curl --location --request GET 'https://api.8x8.com/analytics/work/v{version}/rgsum?pbxId={pbxId here}&startTime=2022-01-03 00:00:00&endTime=2022-05-03 10:00:00&timeZone=America/New_York&extId=100169' \
--header 'Authorization: Bearer {access_token here}' \
--header '8x8-apikey: {8x8-apikey input here}'

Ring Group Member Summary Response

For details on the company summary metrics please refer to Ring Group Member Summary Glossary

📘

Durations are in milliseconds

[
    {
        "pbxId": "acpmecorp",
        "site": "West",
        "firstName": "Marty",
        "lastName": "McFly",
        "ringGroupName": "Management",
        "ringGroupExtension": "100169",
        "extension": "100065",
        "totalAnswered": 0,
        "totalAdvanced": 5,
        "totalTalkTime": 0,
        "totalRingTime": 53821,
        "totalCalls": 5,
        "avgRingTime": 10764,
        "avgTalkTime": 0,
        "offered": 5
    },
    {
        "pbxId": "acpmecorp",
        "site": "West",
        "firstName": "Jane",
        "lastName": "Li",
        "ringGroupName": "Managementz",
        "ringGroupExtension": "100169",
        "extension": "100066",
        "totalAnswered": 2,
        "totalAdvanced": 1,
        "totalTalkTime": 148789,
        "totalRingTime": 31380,
        "totalCalls": 3,
        "avgRingTime": 10460,
        "avgTalkTime": 74394,
        "offered": 3
    }
]

Updated almost 2 years ago