Skip to main content

Data Insights

Introduction

Agora Analytics provides periodic analysis of usage and quality data for Chat, helping you keep track of the usage trends and quality details.

Feature overview

Agora Analytics offers the following features for Chat:

  • Automatic collection, processing, and storage of usage and quality metrics data. This data has a delay of one minute.
  • Display of current and historical data at the user, chat group, and chat room levels, as well as historical trends in message count and message type.
  • Display of the number of request attempts, request success rate, and request delay of API calls at the client side and server side.

After enabling and configuring Chat Service, the Chat-related features in Agora Analytics are enabled by default and are free to use. No additional operation is required.

Usage Insights

Follow these steps to view the Chat Usage Insights page:

  1. Log in to Agora Console, and click Agora Analytics > Chat Usage Insights in the left menu bar.
  2. In the upper left corner, select the project you want to view from the drop-down menu.
  3. Click the Scale Statistics or Message Statistics tab at the top of the page.

Scale Statistics

The Scale Statistics page shows the scale of users, chat groups, and chat rooms on the current day and within a past period. This page includes the following sections:

DescriptionNotes
Today's OverviewValues of key usage metrics as of today. For a detailed description of each metric, see N/A
Historical DataLine charts and bar charts showing how the metric values change in a certain time range.
  • The maximum time range to query is the past 30 days.
  • Each metric in this section is calculated at an interval of a day, and the data has a one-minute delay (except for Daily chat room PCU, which has a delay of 10 minutes).
  • Taking the historical data for chat rooms as an example, the bar chart contains the following information:

    • The red bar chart represents the number of new chat rooms.
    • The cyan bar chart represents the number of disbanded chat rooms.
    • Line charts are used for total chat rooms, peak concurrent users, and daily active chat rooms.

    To hide the bar chart or line chart for a metric, click the corresponding legend.

    Message Statistics

    The Message Statistics page shows the historical numbers of messages and distribution of message types. This page includes the following sections:

    DescriptionNotes
    Message Count TrendsLine charts showing how the total numbers of messages change within a certain time range. For a detailed description of each metric, see
  • The maximum time range to query is the past 6 months.
  • Each metric in this section is calculated at an interval of a day, and the data has a one minute delay.
  • Message Type TrendsLine charts showing the number of messages by type in a certain time range, and pie charts showing the message type breakdown (the percentage of each type of messages). For a detailed description of each metric, see See Message Count Trends

    Taking the uplink message trends of chat rooms as an example, the pie chart contains the following information:

    • By default, it shows the message type breakdown within the selected time range.
    • If you click a data point in the line chart on the left, the pie chart is updated to show the message type breakdown on that specific day. Click the blue Back button to restore the default pie chart.

    Quality Insights

    Follow these steps to view the Chat quality insights page:

    1. Log in to Agora Console, and click Agora Analytics > Chat Quality Insights in the left menu bar.

    2. In the upper left corner, select the project you want to view from the drop-down menu.

    3. (Optional) In the upper right corner, select a unit and duration to view the end-user and server-side API data. The default is to view the last 30 minutes of data by minute.

    You can query any data within the last 7 days. If you view the data by hour, the time range of a single query cannot exceed 24 hours; if you view the data by minute, the time range of a single query cannot exceed 30 minutes.
    1. Click the End-user Data or Server API Data tab at the top of the page.

    End-user Data

    The End-user Data section shows the number of request attempts, request success rate, and average request delay of client-side APIs. For details on the metric types and definitions, see

    To present the data more intuitively, different metrics use different charts:

    MetricMap (on the left)Chart (on the right)
    Request attemptsThe higher the number of request attempts, the darker the color of the area.Line chart.
    1s/3s/5s request success rateThe higher the number of request attempts, the darker the color of the area. The larger the bubble, the lower the request success rate in that area.Line chart.
    Request delayThe higher the number of request attempts, the darker the color of the area. The larger the bubble, the higher the average request delay in that region.Heat map chart, where the horizontal axis is time and the vertical axis is the predefined value buckets of average request delay. The darker the color of the cell, the higher the number of request attempts in the corresponding time range.
    When entering the page for the first time, the chart shows the aggregated metric value of all areas on the map. After clicking an area on the map, the chart is updated to show the metric value of that area alone.

    Server API Data

    The Server API Data section shows the number of request attempts, request success rate, and average request delay of server-side RESTful APIs. For details on the metric types and definitions, see

    Server API data includes the RESTful API calls made by client SDKs. For example, chat group operations on the client SDK is implemented by calling the RESTful API, so it is counted in the Server API data.

    To present the data more intuitively, different metrics use different charts:

    MetricChart
    Request attemptsLine chart.
    1s/3s/5s request success rateLine chart.
    Average request delayHeat map chart, where the horizontal axis is time and the vertical axis is the predefined value buckets of average request delay. The darker the color of the cell, the higher the number of request attempts in the corresponding time range.

    Page Content