Got 5 minutes? Help us improve Admin Console API documentation by taking a quick online survey.

Reports API: Prerequisites

As a prerequisite to using the API, the documentation assumes you have completed these setup steps.

API setup Description
Set up the basics
  • Get a Google Workspace account and create an administrator. You can create user accounts and delegate administrator privileges from the Google Workspace Admin console or using the Directory API.
    The Reports API applies to Google Workspace, Education, and Government accounts.
  • Be familiar with your Google Workspace Admin console found at admin.google.com. For more information about the Admin console, see Use your Admin console.
  • The Reports administrator privilege must be enabled when using the API. A super administrator has this privilege. For delegated administrators, create a custom administrator role.
Set up a Google API Console project Use the API Console to manage and view your application's use of the API's traffic data, your team's membership, and authentication. Set up a new project in the Google API Console, and activate Reports API service for this project. For more information about the APIs Console, see the API Console help.