Reports API: Customer Usage – Google Hangouts Meet Parameters

Overview

The Reports API Customer Usage report returns usage information across your domain.

All Hangouts related metrics that were provided under the Google+ metrics group have been migrated to a newly introduced metrics group called Meet.

This document lists the parameters you can use with the Reports API to obtain details about the duration, size, and device-specific characteristics of the Meet calls across your organization. These metrics reflect aggregated activity across all calls joining to Meet meetings organized by users in your organization.

For more information on migrating from the Hangouts metrics under the Google+ metrics group to the new Metrics, check the migration guide.

Concepts

Meetings

A meeting is the connection of two or more concurrent calls to the same Meet meeting. The reporting metrics consider only meetings directly set up and owned by users within your organization. However, metrics about your meetings do include internal, external, and PSTN (public switched telephone network) participants. By contrast, your reports do not include any activity from meetings arranged by other organizations, even if some of the participants are users from your own organization.

The API calculates meeting duration as the sum of all the intervals with an overlap of two or more calls. The diagram below illustrates how the meeting duration is calculated.

Meet meeting details

The report includes both meetings and calls for the day in which the meeting ends.

Calls

A call is a connection from a client to a Meet meeting. The client can be a mobile app, a web app, or a Chrome device. Each connection counts as a separate call. For example, a single user joining from both a phone and a desktop counts as two separate calls. Or, an interrupted connection that is re-initiated by the same user counts as two separate calls. Call duration refers to the total duration of a given connection, even if there is only one client connected to the meeting at a given point during that call.

Meet reports also consider each client type independently to show usage over different devices. The following table lists the supported client types.

Client type Description
android Any Android phone or tablet using the native Meet application.
chromebox Chromebox for Meetings devices.
chromebase Standalone Chromebase for Meetings devices.
ios Any iOS phone or tablet using the native Meet application.
jamboard Jamboard whiteboards joining to a Meet meeting.
web Any call using the web interface independently of the hardware, operating system, or browser.
unknown_client An unidentified client type.

Chrome devices

Usage of Chrome devices for meetings is divided into two client types based on form factor:

  • Chromebases are simple all-in-one devices to connect to meetings.
  • Chromeboxes are compact computing devices attached to a TV to connect to meetings.

PSTN calls

Participants that connect to a meeting using dial-in or dial-out are considered to be neither internal nor external participants. Instead they are accounted for in the following metrics: num_calls_by_pstn_in_users, total_call_minutes_by_pstn_in_users, num_meetings_with_pstn_in_users, num_calls_by_pstn_out_users, total_call_minutes_by_pstn_out_users and num_meetings_with_pstn_out_users.

Meets reporting time zone

Meet reporting aggregates activity for a single day and sends the report for a single day's activity on the following calendar day. All metrics summarize only activity for the day of the report, considering only finished meetings. All reports use days in the PST time zone, which means that an organization based in Tokyo will receive daily reports that lag 16 hours behind the organization's actual work day. Therefore, meetings that that begin before midnight PST (e.g. 3:30 p.m. JST) on Tuesday, and end after midnight PST on Wednesday (e.g. 4:30 JST) are reported on the second day, once the meeting is over.

Active Users Metrics

A user is active if they connected to a meeting organized by an user inside your organization.

Table: Active users metrics (only integers returned, day of the report in PST)
Metric name Description
num_1day_active_users
num_7day_active_users
num_30day_active_users
Total number of unique internal user accounts active in a given time window.

Call Metrics

Table: Total number of calls (only integers returned, day of the report in PST)
Metric name Description
num_calls Total number of calls to meetings organized by your users.
num_calls_by_internal_users
num_calls_by_external_users
Total number of calls using any Meet application. Calls are split between connections from internal users and connections from external users.
These metrics do not include PSTN calls, which are tracked separately.
num_calls_by_pstn_in_users Total number of PSTN calls that dialed-in to meetings.
num_calls_by_pstn_out_users Total number of PSTN calls that dialed-out from meetings.
Table: Call duration (only integers returned, day of the report in PST)
Metric name Description
total_call_minutes Total duration of all connected calls.
total_call_minutes_by_internal_users
total_call_minutes_by_external_users
Total duration of connected calls divided by internal and external users.
These metrics do not include PSTN calls, which are tracked separately.
total_call_minutes_by_pstn_in_users Total duration of PSTN calls dialing into Meet.
total_call_minutes_by_pstn_out_users Total duration of PSTN calls dialing out from Meet.
Table: Number of calls and duration by CLIENTTYPE - Refer to the Client Type table above for a full list of client types (only integers returned, day of the report in PST)
Metric name Description
num_calls_CLIENTTYPE Total number of calls by CLIENTTYPE.
total_call_minutes_CLIENTTYPE Total duration of calls by CLIENTTYPE.

Meeting Metrics

Table: Number of meetings (only integers returned, day of the report in PST)
Metric name Description
num_meetings Total number of meetings.
num_meetings_with_external_users Total number of meetings that include at least one external user or caller.
num_meetings_with_pstn_in_users Total number of meetings that include at least one user connected through PSTN dial-in.
num_meetings_with_pstn_out_users Total number of meetings that include at least one user connected through PSTN dial-out.
num_meetings_CLIENTTYPE Total number of meetings held on the date of the report that include at least one call from CLIENTTYPE.
lonely_meetings Total meetings not counted due to having less than two concurrent calls. These meetings are not counted in num_meetings and related metrics.
Table: Meeting distribution by size (only integers returned, day of the report in PST)
Metric name Description
num_meetings_with_2_calls
num_meetings_with_3_to_5_calls
num_meetings_with_6_to_10_calls
num_meetings_with_11_to_15_calls
num_meetings_with_16_to_25_calls
num_meetings_with_26_to_50_calls
Total number of meetings broken down by the maximum number of concurrent calls.
Table: Meeting total duration and averages (only integers returned, day of the report in PST)
Metric name Description
total_meeting_minutes Total meeting duration on the date of the report.
average_meeting_minutes
average_meeting_minutes_with_2_calls
average_meeting_minutes_with_3_to_5_calls
average_meeting_minutes_with_6_to_10_calls
average_meeting_minutes_with_11_to_15_calls
average_meeting_minutes_with_16_to_25_calls
average_meeting_minutes_with_26_to_50_calls
Average duration of meetings in minutes broken down by maximum number of concurrent calls.

Chromebox and Chromebase Metrics

Table: Meet usage metrics for Chrome devices (only integers returned, day of the report in PST)
Metric name Description
max_concurrent_usage_chromebox Number of Chromebox for meetings devices connected to any internal meetings at the same time.
max_concurrent_usage_chromebase Number of Chromebase for meetings devices connected to any internal meetings at the same time.

Enviar comentários sobre…

Precisa de ajuda? Acesse nossa página de suporte.