📘

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

TODO

• Add note about deprecation of old
• remove ring group summary content
• change URLS
  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

Body

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 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

Path

Query

Ring Group Member Summary Request

As per the Open API specification guidelines, we have migrated the URLs for Ring Group Member Summary Report as give in the below table :

📘

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-members?pbxId={pbxId here}&startTime=2022-01-03 00:00:00&endTime=2022-05-03 10:00:00&timeZone=America/New_York&extId={extId here}' \
--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
    }
]