Reporting
Auvious offers a dashboard dedicated explicitly to reports and data visualisation. These reports however are also available via API so that you can create powerful metrics on your own system.
URL
| Method | Url |
|---|---|
GET | api/reporting/metrics/:duration-type/:report-type |
You can read more on reporting on our Reporting API section.
Example:
Say we want the number of video calls per day created in January of 2023. The URL would be like this :
GET api/reporting/metrics/daily/video_calls_created?month=1&year=2023
Authentication
OAuth 2.0 Authorization. Authenticate using client credentials that can be created at the settings page.
Glossary
Video call
A video call is a webRTC room where video and/or audio data are transmitted between one or more participants.
Interaction
An interaction is a communication between a customer and an agent that may or may not have a video call, a co-browse or any other type.
Rating
A rating is a review (1 to 5 stars) and a accompanying text if the review is less than 5 stars, that either the customer or the agent provides at the end of a call when requested to review the quality of the video/audio.
Concurrent call
A concurrent call is two or more video calls that are happening at the same time by different agents.
Conference
A conference is a webRTC room that may or may not have audio/video streams.
Call
A call is an exchange of audio/video streams between two or more participants inside a conference.
Report types
The available report types that can be queried are:
| Type | Description | Value |
|---|---|---|
| Video calls created | Number of video calls created, regardless if any participant joined | video_calls_created |
| Video calls performed | NUmber of video calls that at least one participant joined | video_calls_performed |
| Video calls with small duration | Number of video calls with duration less than X seconds | video_calls_with_small_duration |
| Video calls with normal duration | Number of video calls with duration between X and Y seconds | video_calls_with_normal_duration |
| Video calls with long duration | Number of video calls with duration more than Y seconds | video_calls_with_long_duration |
| Interactions created | Number of interactions created | interactions_created |
| Ratings submitted | Number of ratings submitted | ratings_submitted |
| Rating average score | Average score of ratings submitted | rating_score_average |
| Max concurrent calls | Maximum number of calls happening at the same time | concurrent_calls_max |
| Average concurrent calls | Average number of calls happening at the same time | concurrent_calls_avg |
| Average duration of conference | Average duration of a conference | conference_average_duration |
| Average duration of call | Average duration of a call | call_average_duration |
Duration types
| type | value |
|---|---|
| Hourly | hourly |
| Daily | daily |
| Weekly | weekly |
| Monthly | monthly |
| Yearly | yearly |
| Total | total |
Query params
Query params are used to limit the metrics received between a certain range.
| Type | Value | Can be used in duration type | Available values |
|---|---|---|---|
| Day | day | hourly | 1 - 31 |
| Month | month | hourly, daily, | 1 - 12 |
| Year | year | hourly, daily, weekly, monthly, | 1970 - current year |
| Start of year | startYear | yearly | 1970 - current year |
| End of year | endYear | yearly | 1970 - current year |