This document lists the parameters you use to request organization-wide Google Drive behavior metrics. These metrics reflect aggregated Google Drive activity across all users in your organization. You can further segment reporting metrics into two elements:
- Actor metrics
- The person performing the action on a file.
- Owner metrics
- The person who owns the file being acted on.
ownedin their names refer to owner data.
Parameters can provide aggregate visibility and ownership metrics for items within your domain. These parameters fall into three general categories:
- Added—those Docs or Drive items with at least one
additiontype event performed on them such as create, uploads, untrash events, or ownership transfer. This activity gets reported regardless of the final state of the item. Multiple
additionevents to the same file do not increment the count.
- Removed—those Docs or Drive items with at least one
removaltype event performed on them, such as trash, permanent delete, or ownership transfer. This activity gets reported regardless of the final state of the item.
- Delta—the net change in number of Google Docs and Drive items owned for the entire domain, segmented by user. For example, if one item gets added and another gets removed, the added and removed metrics each report 1, but the delta metric reports 0.
For event totals, only one
per item counts toward the final value. For example, if a file is first
added to Drive and then transferred to another owner, this triggers two
addition events and one
removal event, but the final
tally for that file is one addition and one removal.
Visibility parameters take the following form, where * is replaced by any of the fields listed in the table below:
The following table lists fields in order of visibility from lowest (private) to highest (public).
|private||The file is not shared with anyone.|
|shared_internally||The file is shared only with users/groups within the owner's domain.|
|anyone_in_domain_with_link||The file is shared so that anyone in the domain with the link can access.|
|anyone_in_domain||The file is shared so that anyone in the domain can find and access it.|
|shared_externally||The file is shared so that users/groups external to the owner's domain can see it.|
|anyone_with_link||The file is shared so that anyone with the link can access.|
|public||The file is publicly accessible.|
Metrics on multiple visibility levels or events
Calculation for visibility metrics considers only the highest—or most
public—visibility state for any given file. For example, consider the following
sharing settings applied to a single file. While the file has multiple
visibilities states, only the
public visibility state is reported.
|Sharing setting||Visibility state|
|Shared with a few users in the domain||
|Shared with specific users outside the domain||
User activity parameters
The following parameters provide user activity data for your Google Drive and Docs activity. Activity falls into two categories:
- Owned items activity
- All parameters with
owned_itemsin the name; activity metrics apply only to actions from any user (external or internal) only on items owned by domain users.
- General items activity
- Activity metrics apply to any activity made by domain users, whether or not the item is owned by the domain.
|num_1day_active_users||The number of domain users who performed an activity on a given report day.|
|num_7day_active_users||The number of domain users who performed an activity on the report date or the 6 days prior.|
|num_30day_active_users||The number of domain users who performed an activity on the report date or the 29 days prior.|
|The number of domain users active on the report date. Only includes users who performed an activity on the specified file format item.|
|The number of domain users active at least once in the past 7 days (including the report date). Only includes users who performed an activity on the specified file format item.|
|The number of domain users active at least once in the past 30 days (including the report date). Only includes users who performed an activity on a specific file format item.|
|num_creators||Number of domain users who create files, regardless of ownership -- creators can be creating their own files. Includes uploading content but not other addition type events like UNTRASH and ownership transfer.|
|num_collaborators||Number of domain users editing and commenting/suggesting/marking to-dos on files, but only on files they do not own.|
|num_consumers||Number of domain users viewing files, again regardless of ownership -- consumers could view their own files and be counted. Does not include printing or previewing.|
|num_sharers||Number of domain users who increase item visibility. Relevant visibility events include: changing file visibility to a more public level, or adding more users/groups even if the visibility level stays the same or even decreases (such as changing from anyone in the domain to anyone in the domain with a link). Files acted upon are counted regardless of domain ownership of the file.|
|Number of items created by the user or domain. Does not track items that came into the user/customer's possession by way of un-trashing, un-deleting, or ownership transfer. Also available by specific file format.|
|Number of items trashed by the user or customer on the day of the report. If an item is trashed at first, but then restored within the reporting window, it is still counted in the metric. If an item is trashed multiple times, it is counted only once in the metric. Also available by specific file format.|
|Number of items edited by the user/customer on the day of the report. Multiple edits of the same file are counted just once per file. Also available by specific file format.|
|Number of items viewed by the user/customer on the day of the report. Multiple views of the same file are counted just once per file. Also available by specific file format.|
|Net change in number of items owned. If one item gets added but another gets removed, each of the metrics will report 1 (should you query for items added and items removed), but the net change will be 0. Also available by specified file format.|
|Number of items with at least one "addition" type event performed on them, such as create, uploads, untrash events, or ownership transfer.. This activity gets reported regardless of the final state of the item.|
|Number of items with at least one "removal" type event performed on them, such as trash, permanent delete, or ownership transfer. This activity gets reported regardless of the final state of the item. Also available by specified file format.|
|Number of items created on the day of the report for which the domain's user is the owner. Does not track items that came into the customer's possession by way of un-trashing, un-deleting, or ownership transfer. Also available by specified file format.|
|Number of items owned by the domain trashed on the day of the report. If an item is trashed at first, but then restored, it is still counted in the metric. If an item is trashed multiple times, it is counted only once in the metric. Also available by specified file format.|
|Number of items owned by the customer that got edited on the day of the report. Multiple edits of the same file are counted just once per file. Also available by specified file format.|
|Number of items owned by the customer that got viewed on the day of the report (by anyone). Multiple views of the same file are counted just once per file. Also available by specified file format.|