AI-generated Key Takeaways
-
The Reports API generates aggregate reports on managed ChromeOS device and Chrome Browser deployments.
-
The API offers methods to count various aspects of your deployment, such as devices needing attention, devices reaching auto expiration, hardware fleet devices, Chrome versions, and installed apps.
-
You can also use the API to count print jobs by printer or user and get a detailed report of print jobs.
-
Different Admin privileges are required depending on the specific report you want to generate.
-
The Reports API requires the
https://www.googleapis.com/auth/chrome.management.reports.readonlyOAuth scope.
The Reports API enables you to generate reports that give you aggregate information on your managed ChromeOS device / Chrome Browser deployment.
Quick overview of API methods
URLs are relative to https://chromemanagement.googleapis.com/v1/customers/ $CUSTOMER
| Description | Relative URL | Http method | Allowed request parameters |
|---|---|---|---|
|
Count Chrome browsers needing attention in your domain
|
/reports:countChromeBrowsersNeedingAttention | GET | Optional : orgUnitId |
|
Count Chrome devices reaching auto expiration date in your domain
|
/reports:countChromeDevicesReachingAutoExpirationDate | GET | Optional : orgUnitId, minAueDate, maxAueDate |
|
Count Chrome devices needing attention in your domain
|
/reports:countChromeDevicesThatNeedAttention | GET | Optional : orgUnitId, readMask |
|
Count Chrome hardware fleet devices in your domain
|
/reports:countChromeHardwareFleetDevices | GET | Optional : orgUnitId, readMask |
|
Count versions of Chrome deployed to devices in your domain
|
/reports:countChromeVersions | GET | Optional : orgUnitId, filter, pageSize, pageToken |
|
Count the reported apps installed across your devices and browsers
|
/reports:countInstalledApps | GET | Optional : orgUnitId, filter, pageSize, pageToken, orderBy |
|
Get a summary of printing done by each printer in your domain
|
/reports:countPrintJobsByPrinter | GET | Optional : printerOrgUnitId, filter, pageSize, pageToken, orderBy |
|
Get a summary of printing done by each user in your domain
|
/reports:countPrintJobsByUser | GET | Optional : printerOrgUnitId, filter, pageSize, pageToken, orderBy |
|
Get a detailed report of print jobs in your domain
|
/reports:enumeratePrintJobs | GET | Optional : printerOrgUnitId, filter, pageSize, pageToken, orderBy |
|
List the devices on which a particular app is installed
|
/reports:findInstalledAppDevices | GET | Optional : orgUnitId, filter, pageSize, pageToken, orderBy |
|
Get a count of Chrome crash events
|
/reports:countChromeCrashEvents | GET | Optional : orgUnitId, filter, orderBy |
See code samples for example requests and responses.
Admin Privileges
Reports API respects admin role delegation. Depending on which reports the admin wants to generate, different admin privileges are required.
| Method | Admin privileges required |
|---|---|
| countChromeBrowsersNeedingAttention | "Services -> Chrome Management -> View Chrome Insights Report" or "Services -> ChromeOS -> Settings -> View Chrome Insights Report" |
| countChromeDevicesReachingAutoExpirationDate | "Services -> Chrome Management -> View Chrome Insights Report" or "Services -> ChromeOS -> Settings -> View Chrome Insights Report" |
| countChromeDevicesThatNeedAttention | "Services -> Chrome Management -> View Chrome Insights Report" or "Services -> ChromeOS -> Settings -> View Chrome Insights Report" |
| countChromeHardwareFleetDevices | "Services -> Chrome Management -> View Chrome Insights Report" or "Services -> ChromeOS -> Settings -> View Chrome Insights Report" |
| countChromeVersions | "Services -> Chrome Management -> View Chrome Versions Report" or "Services -> ChromeOS -> Settings -> View Chrome Versions Report" |
| countInstalledApps | "Services -> Chrome Management -> View Extensions List Report" or "Services -> ChromeOS -> Settings -> View Extensions List Report" |
| countPrintJobsByPrinter | "Services -> Chrome Management -> View Chrome Printers Report" or "Services -> ChromeOS -> Settings -> View Chrome Printers Report" |
| countPrintJobsByUser | "Services -> Chrome Management -> View Chrome Printers Report" or "Services -> ChromeOS -> Settings -> View Chrome Printers Report" |
| enumeratePrintJobs | "Services -> Chrome Management -> View Chrome Printers Report" or "Services -> ChromeOS -> Settings -> View Chrome Printers Report" |
| findInstalledAppDevices | "Services -> Chrome Management -> View Extensions List Report" or "Services -> ChromeOS -> Settings -> View Extensions List Report" |
| countChromeCrashEvents | "Services -> Chrome Management -> View Chrome Crash Report" or "Services -> ChromeOS -> Settings -> View Chrome Crash Report" |
To manage admin roles and privileges visit "Admin Console -> Admin Roles".
API scopes
Reports API requires the following OAuth scope:
https://www.googleapis.com/auth/chrome.management.reports.readonly
For more information, see the Authentication Overview .
