Many of our customers would like to understand the adoption rate as new employees start to use Chime as a chat based service desk. In many cases, this is driven by internal corporate KPI metrics - and the requirement to determine exactly how many employees are using a newly deployed software application.

This article provides essential information on accessing the 'New Guest Users Since Date' report both in the Chime UI and via the API. Here, you'll find details about the report's URL, API endpoint, and example code to effectively generate this report.

Accessing the 'New Guest Users Since Date' Report in Chime UI

How can I access the 'New Guest Users Since Date' report in the Chime UI?
To access the 'New Guest Users Since Date' report in the Chime UI, follow these steps:

Log in to the Chime web portal using your credentials.
Navigate to the Reports section.
Locate the 'New Guest Users Since Date' report and click on it.
Specify the desired date for filtering and generate the report.

Accessing the 'New Guest Users Since Date' Report via the API

How can I access the 'New Guest Users Since Date' report using the API?
You can access the 'New Guest Users Since Date' report through the Chime V4 Reporting API. The API endpoint to retrieve this report is as follows:

View the ‘New Guest Users Since Date’ report in Charts & Metrics

The ‘New Guest Users Since Date’ report can be found under the ‘Text Analytics’ category

Global Report URL: https://example.com/Chime/Report/NewGuestsSinceDate_Global

Queue Report URL: https://example.com/Chime/Report/NewGuestsSinceDate

You'll need to use the API key for authentication. Here's how you can use it in your requests.

Example Code

CURL

curl --location --request GET 'https://example.com/Chime/Report/NewGuestsSinceDate_Global?start=2023-01-01&csv=true' \
--header 'Authorization: Bearer YOUR_API_KEY'

jQuery

var settings = {
  "url": "https://example.com/Chime/Report/NewGuestsSinceDate_Global?start=2023-01-01&csv=true",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer YOUR_API_KEY"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

Nodejs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://example.com/Chime/Report/NewGuestsSinceDate_Global?start=2023-01-01&csv=true',
  'headers': {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

With these examples, you can efficiently access the 'New Guest Users Since Date' report both within the Chime UI and via the API using your API key.

Related Items

Explore these additional resources to enhance your understanding of Chime's reporting capabilities and make the most out of the Chime V4 Reporting API.

Your Guide to Accessing ‘New Users Since Date’ Report in Chime V4