Reports API: Revision History

Stay organized with collections Save and categorize content based on your preferences.

This page lists the Reports API (v1) changes and documentation updates.

May 14, 2020

A new parameter member_type has been added to the Enterprise Groups activity report. Valid member types include user, group, service account, and other.

July 30, 2019

The customer usage reports for App Maker and Apps Script are deprecated and will eventually be removed from the API.

October 22, 2018

The community_name parameter for the Google+ communities report is now available only for communities inside your organization.

August 1, 2018

The availability of past data for the Entities Usage Report has been changed to 30 days.

June 4, 2018

We have fixed an issue where some Entities Usage Parameters were under-reported for some Google+ communities. This has been corrected as of May 25, 2018.

December 11, 2017

We have created the Entities Usage Report to generate reports on entities used by your account's users. The API currently supports reporting for Google+ communities.

July 11, 2017

Nine new parameters have been added to the Google+ customer usage report. The new parameters are:

  • num_communities
  • num_communities_public
  • num_communities_private
  • num_communuties_organization_wide
  • num_communities_organization_private
  • num_collections
  • num_collections_public
  • num_collections_organization_wide
  • num_collections_organization_private
In addition, the Google+ user usage report was created with seven metrics:

  • num_shares
  • num_plusones
  • num_plusones_received
  • num_replies
  • num_replies_received
  • num_reshares
  • num_reshares_received

May 11, 2017

We have added the App Maker and Apps Script customer usage reports to the customerUsageReports.get method. These new reports allow you to view information about App Maker and Apps Script usage in your domains.

April 5, 2017

Google Docs customer and usage reports are being replaced by Google Drive customer and usage metrics. See details in Update your Drive and Docs Metrics.

March 14, 2017

Six new parameters have been added to the Google+ customer usage report. The new parameters are:

  • num_new_users
  • num_shares
  • num_reshares
  • num_plusones
  • num_replies
  • num_stream_items_read

February 2, 2015

We have added the Mobile Device customer usage report to the customerUsageReports.get method. This new report allows you to view information about mobile device usage in your domains.

We've amended the release notes to include the ChromeOS report, which was released October 27, 2014.

December 11, 2014

We have added the Google Calendar audit report to the activities.list method. This new report allows you to view information about changes to calendars and calendar events for users in your domain.

November 20, 2014

We have added the Google Sites customer usage report to the customerUsageReports.get method. This new report allows you to view information about Google Sites usage in your domains.

November 12, 2014

We have added the OAuth Token Audit reporting application to the activities.list method. This new report allows you to view information about third party websites and applications that users in your domains have granted access to.

October 29, 2014

New parameters have been added to the Gmail customer usage report. The new parameters are:

  • num_inbound_delivered_emails
  • num_inbound_rerouted_emails
  • num_inbound_rejected_emails
  • num_inbound_spam_emails
  • num_inbound_non_spam_emails
  • num_inbound_encrypted_emails
  • num_inbound_unencrypted_emails
  • num_outbound_delivered_emails
  • num_outbound_rerouted_emails
  • num_outbound_rejected_emails
  • num_outbound_encrypted_emails
  • num_outbound_unencrypted_emails

October 27, 2014

We have added the ChromeOS Devices customer usage report to the customerUsageReports.get method. This new report allows you to view information about ChromeOS device usage in your domains.

September 2, 2014

The maximum time limit for usage reports has been increased from 180 days to 450 days. Because this change will take time to populate in our data, the full 450 day history will be available on May 30, 2015 with an earliest available record date of March 6, 2014.

August 15, 2014

A new view event has been added to the Drive activity report.

June 25, 2014

The Drive activity report is now available in the Reports API. This new report provides insight about Drive activity and how your account's users manage, modify, and share their Google Drive documents. This report is available only for G Suite Business customers and replaces the Google Docs activity report. The Google Docs activity report is now deprecated and will cease functioning on January 31, 2015.

June 5, 2014

Both customer and user Gmail reports now include default values. For example, if a user sends no email, the num_emails_sent parameter is returned as 0. Previously, if there was no data for a field, that field was omitted from the report.

May 27, 2014

The Reports API now includes usage statistics from suspended users in Customers Usage reports.

April 23, 2014

A change has been made to how parameters with no data are returned by the API. Previously, if there was no data for a parameter, it woulid be absent from the report. For example, the Gmail user usage report would not include the num_emails_sent field in the response if a user didn't send any emails on the report date. The API now returns these parameters with a default of 0 for integers and false for boolean values.

April 15, 2014

A new num_users_2sv_not_enrolled_but_enforced parameter has been added to the customer accounts usage report. This new parameter indicates the number of domain users that have 2-step verification enforced but have not enrolled.

March 27, 2014

Two new login_failure_type values have been added to the Login Audit events: login_failure_account_disabled and login_failure_unknown.

A bugfix has been implemented for an issue that caused filters to use case-sensitive comparisons. All filters are now case-insensitive.

March 5, 2014

A bugfix has been implemented for an issue that caused filters to be ignored on queries for single users and always return a single record. After the fix, queries for single users that also include filters will return no result if the user does not match the filter criteria.

February 28, 2014

A bugfix has been implemented for an issue that caused certain statistics on numbers of active users to include one extra day. Some domains may notice a decrease in the number of reported active users for reports after February 24, 2014. The affected fields are:

  • Accounts
    • num_1day_logins
    • num_7day_logins
    • num_30day_logins
  • Google Calendar
    • num_1day_active_users
    • num_7day_active_users
  • Google Docs
    • num_1day_active_users
    • num_7day_active_users
    • num_30day_active_users
  • Gmail
    • num_1day_active_users
    • num_7day_active_users
    • num_30day_active_users
  • Google+
    • num_1day_active_users
    • num_7day_active_users

Additionally, several new fields have recently been added to the Customer Account Usage and Users Account Usage reports. The new fields are:

  • Customer Accounts
    • num_authorized_apps
    • authorized_apps
    • drive_used_quota_in_mb
    • gmail_used_quota_in_mb
    • gplus_photos_used_quota_in_mb
    • total_quota_in_mb
    • used_quota_in_mb
    • apps_total_licenses
    • apps_used_licenses
    • vault_total_licenses
    • coordinate_total_licenses
  • User Accounts
    • num_authorized_apps
    • drive_used_quota_in_mb
    • gmail_used_quota_in_mb
    • gplus_photos_used_quota_in_mb
    • total_quota_in_mb
    • used_quota_in_mb
    • used_quota_in_percentage

February 10, 2014

Suspended users are now included in the statistics for Docs reports. Some domains may notice an increase in the number of reported documents.

The following parameters have been added to the User's usage report:

  • Accounts
    • used_quota_in_percentage
  • Docs
    • num_docs_externally_visible
    • num_docs_internally_visible
  • Gmail
    • num_emails_exchanged

January 27, 2014

Added push notifications for changes to the Activities resource. This is exposed in the API as two new methods, activities.watch and channels.stop, to start and stop receiving notifications.

December 3, 2013

Added support for resellers to retrieve usage reports and audit information for a specific customer. This is exposed in the API as a new customerId parameter for the activities.list, customerUsageReports.get, and userUsageReport.get methods.

April, 2013

This section highlights some of the differences between the Reports API and the deprecated G Suite Admin Audit API (v1). For more information about the Reports API's administrator activities, see the Developer's Guide, the API Reference, and the Admin Activities Events reference.

API Features Reports API (v1) Deprecated Admin Audit API (v1)
applicationId and applicationName The admin activity report uses applicationName: "admin" to identify the Admin console. For more information, see the API Reference. The Admin Audit API identifies the Admin console application with an "applicationId": "207535951991".
Control panel's CSV export feature In this version of the Reports API, this feature is not supported. This is supported in the Admin Audit API.
eventType and type The admin activity report returns a type parameter. The Admin Audit API uses eventType for an event category.
OAuth and OAuth scope The Reports API uses the OAuth 2.0 protocol. The Admin Audit API OAuth scope is not supported in the Reports API.
Pagination For reports with multiple response pages, the Reports API supports maxResults and pageToken query strings and the nextPageToken response parameter. The Admin Audit API supports maxResults, rel, and next parameters.
Resource URLs The admin activity report has a different URL which does not use the customerId. The admin activity report URL is https://www.googleapis.com/admin/reports/v1/activity/users/userKey | all/applications/admin The Admin Audit API URL is https://www.googleapis.com/apps/reporting/audit/v1/the customer ID/the application ID
Time and date format The Reports API requests support time in ISO 8601 yyyy-mm-dd format. The Reports API responses are in UNIX epoch time in seconds. The Admin Audit API uses UTC format.