The dimensions and metrics supported in queries to the Data Access Reports method of the Analytics Admin API.
Dimensions
The following dimensions can be requested in data access reports. Specify the "API Name" in an AccessDimension's dimension name field for a column of the dimension in the report response.
| API Name | UI Name | Description |
|---|---|---|
| accessMechanism | Access Mechanism | The mechanism through which a GA user accessed GA reporting data. Possible values include 'Google Analytics User Interface', 'Google Analytics API', 'Firebase', 'Google Ads', and others. |
| accessedPropertyId | Accessed Property ID | The property ID where GA reporting data was accessed. Most Data Access Reports contain only one property, but if the requested property has a sub-property, Data Access Reports contain accesses to both the source property & sub-property. To learn more about sub-properties, see https://support.google.com/analytics/answer/11525732 |
| accessedPropertyName | Accessed Property Name | The property display name where GA reporting data was accessed. Most Data Access Reports contain only one property, but if the requested property has a sub-property, Data Access Reports contain accesses to both the source property & sub-property. To learn more about sub-properties, see https://support.google.com/analytics/answer/11525732 |
| costDataReturned | Cost data returned | Returns 'true' if cost data was returned in this report. Otherwise, this dimension returns 'false'. GA users with the 'No Cost Metrics' restriction are unable to see cost metrics. This dimension will always be 'false' while that restriction is active. To learn more, see Access and data-restriction management. |
| epochTimeMicros | Epoch time micros | The unix microseconds since the epoch that the GA user accessed GA reporting data. For example, a unix microsecond of '1655220215027371' is 2022-06-14 11:23:35 in America/New_York. |
| mostRecentAccessEpochTimeMicros | Most recent access epoch time micros | The most recent access timestamp for this row. Returned in unix microseconds since the epoch. Commonly used with 'userEmail' & similar dimensions to determine the last access times of GA users. |
| propertyUserLink | Property User Link | The resource name identifying a property's user link. For example, this 'propertyUserLink' could return 'properties/227742705/userLinks/101897404079322829461'. This resource name is available to make editing user permissions based on a Data Access Report easier. For example, this 'propertyUserLink' can be directly passed to the following method to delete the user's link: https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.userLinks/delete |
| reportType | Report Type | The type of reporting data that the GA user accessed. Possible values include 'Reporting', 'Realtime', 'Free form exploration', 'Funnel exploration', and others. |
| revenueDataReturned | Revenue data returned | Returns 'true' if revenue data was returned in this report. Otherwise, this dimension returns 'false'. GA users with the 'No Revenue Metrics' restriction are unable to see revenue metrics. This dimension will always be 'false' while that restriction is active. To learn more, see Access and data-restriction management. |
| userEmail | User email | The email of the GA user that accessed GA reporting data. Some integrations allow users to access GA reporting data through the integration without the user having direct access to the property; in that case, 'userEmail' will return for example 'Google Ads Linked User' depending upon the integration. |
| userIP | User IP | The IP of the GA user that accessed GA reporting data. |
Metrics
The following metrics can be requested in data access reports. Specify the "API Name" in an AccessMetric's metric name field for a column of the metric in the report response.
| API Name | UI Name | Description |
|---|---|---|
| accessCount | Access count | The number of times GA reporting data was accessed. |