Get Started with the Chime Reporting API
We want to make getting started with the Reporting API as easy as possible, so here is a quick guide on how to go from having nothing set up on your Chime instance to being proficient in getting reports with our API.
For a more detailed writeup, see our blog on Using the Chat Reporting API + Tips and Tricks.
Prerequisite
To use the Reporting API with Chime V5, you will want to be added as an Administrator on your Chime tenant.
Step 1 - Create a Reporting API Key
To create an API key for a user, follow these simple steps:
1) Navigate to your Chime instance and log in
2) Go to your User Profile by clicking your user icon in the top-right of the page and selecting Profile.
3) If you don’t already have an API key, click the Generate New API Key button.
4) Save the updated settings.
Step 2 - Get to the Reporting API Playground
Now that you have an API Key set up, you can start using the Reporting API Playground we have added to help you build the API calls and make formatting everything easy. To get there, follow these steps:
1) Go to the Admin Dashboard by clicking your user icon in the top-right of the page and selecting Admin Dashboard.
2) On the left-side menu, click the dropdown for Chime Content.
3) Next, click the Charts and Reports dropdown.
4) Then, click the Report API Playground button.
Step 3 - Using the Reporting API Playground
What You Need in a Request
To interact with the Chime V5 Reporting API effectively, you should understand the three key components of each request:
1) The URL of the Report: This specifies the report you want to access.
2) Query String Parameters: These parameters ensure that your request is processed correctly. You'll typically need to include startDate, stopDate, format, and reportId.
3) Authorization Header (API Key): To authenticate your request, you'll need to include the API key in the Authorization header. The format for the authorization header should be: "Bearer {API Key}" under the value column in the headers menu.
Here are examples of what a request may look like. We will explain how to generate these in the next 2 sections.
Get Available Reports:
{{baseUrl}}/api/reporting/AvailableReportsExample Report:
{{baseUrl}}/api/reporting/report/${reportId}?format=${format}&startDate=${startDate}&endDate=${endDate}
Get All Available Reports
The first view that you get in the Reporting API Playground will be of the Get Available Reports tab. This will allow you to get the name and id of all of the available reports. We would recommend executing this so that you can have a list of all of your report IDs if you want to be able to manually create report requests.
Get Specific Reports - JS Code for Report and Response Format
This section of the Reporting API Playground lets you build report requests easily by providing you with all of the JS code needed to get a report so if you are using another app like Power BI you can pull format, and modify it slightly to fit the use case you have for it.
In this area you can choose the reports you want to run, start and end times, and format you want it to come back with. We will automatically build out the report call for you and have variables in the request so you are able to customize them easier.
After you execute the report you can also see the response so that if you want to manipulate the data in the future you can see exactly what the formatting is for it.