---
title: "POST /v1beta/{+entity}:runAccessReport"
method: POST
path: "/v1beta/{+entity}:runAccessReport"
tags: ["accounts"]
---

# POST /v1beta/{+entity}:runAccessReport

`POST /v1beta/{+entity}:runAccessReport`

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.

## Path parameters

- `entity` string, required

## Request body

- GoogleAnalyticsAdminV1betaRunAccessReportRequest — The request for a Data Access Record Report.
  - `dimensionFilter` GoogleAnalyticsAdminV1betaAccessFilterExpression — Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.
    - `orGroup` GoogleAnalyticsAdminV1betaAccessFilterExpressionList — A list of filter expressions.
      - `expressions` GoogleAnalyticsAdminV1betaAccessFilterExpression[] — A list of filter expressions.
    - `andGroup` GoogleAnalyticsAdminV1betaAccessFilterExpressionList — A list of filter expressions.
      - `expressions` GoogleAnalyticsAdminV1betaAccessFilterExpression[] — A list of filter expressions.
    - `notExpression` GoogleAnalyticsAdminV1betaAccessFilterExpression — recursive
    - `accessFilter` GoogleAnalyticsAdminV1betaAccessFilter — An expression to filter dimension or metric values.
      - `stringFilter` GoogleAnalyticsAdminV1betaAccessStringFilter — The filter for strings.
        - `caseSensitive` boolean — If true, the string value is case sensitive.
        - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'EXACT' | 'BEGINS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'FULL_REGEXP' | 'PARTIAL_REGEXP' — The match type for this filter.
        - `value` string — The string value used for the matching.
      - `betweenFilter` GoogleAnalyticsAdminV1betaAccessBetweenFilter — To express that the result needs to be between two numbers (inclusive).
        - `fromValue` GoogleAnalyticsAdminV1betaNumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
        - `toValue` GoogleAnalyticsAdminV1betaNumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
      - `inListFilter` GoogleAnalyticsAdminV1betaAccessInListFilter — The result needs to be in a list of string values.
        - `caseSensitive` boolean — If true, the string value is case sensitive.
        - `values` string[] — The list of string values. Must be non-empty.
      - `fieldName` string — The dimension name or metric name.
      - `numericFilter` GoogleAnalyticsAdminV1betaAccessNumericFilter — Filters for numeric or date values.
        - `value` GoogleAnalyticsAdminV1betaNumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
        - `operation` 'OPERATION_UNSPECIFIED' | 'EQUAL' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL' — The operation type for this filter.
  - `returnEntityQuota` boolean — Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false.
  - `dateRanges` GoogleAnalyticsAdminV1betaAccessDateRange[] — Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.
    - `startDate` string — The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.
    - `endDate` string — The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.
  - `limit` string, int64 — The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
  - `offset` string, int64 — The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
  - `expandGroups` boolean — Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.
  - `includeAllUsers` boolean — Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.
  - `orderBys` GoogleAnalyticsAdminV1betaAccessOrderBy[] — Specifies how rows are ordered in the response.
    - `dimension` GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy — Sorts by dimension values.
      - `dimensionName` string — A dimension name in the request to order by.
      - `orderType` 'ORDER_TYPE_UNSPECIFIED' | 'ALPHANUMERIC' | 'CASE_INSENSITIVE_ALPHANUMERIC' | 'NUMERIC' — Controls the rule for dimension value ordering.
    - `metric` GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy — Sorts by metric values.
      - `metricName` string — A metric name in the request to order by.
    - `desc` boolean — If true, sorts by descending order. If false or unspecified, sorts in ascending order.
  - `metrics` GoogleAnalyticsAdminV1betaAccessMetric[] — The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
    - `metricName` string — The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this API. Metrics are referenced by name in `metricFilter` & `orderBys`.
  - `metricFilter` GoogleAnalyticsAdminV1betaAccessFilterExpression — Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.
    - `orGroup` GoogleAnalyticsAdminV1betaAccessFilterExpressionList — A list of filter expressions.
      - `expressions` GoogleAnalyticsAdminV1betaAccessFilterExpression[] — A list of filter expressions.
    - `andGroup` GoogleAnalyticsAdminV1betaAccessFilterExpressionList — A list of filter expressions.
      - `expressions` GoogleAnalyticsAdminV1betaAccessFilterExpression[] — A list of filter expressions.
    - `notExpression` GoogleAnalyticsAdminV1betaAccessFilterExpression — recursive
    - `accessFilter` GoogleAnalyticsAdminV1betaAccessFilter — An expression to filter dimension or metric values.
      - `stringFilter` GoogleAnalyticsAdminV1betaAccessStringFilter — The filter for strings.
        - `caseSensitive` boolean — If true, the string value is case sensitive.
        - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'EXACT' | 'BEGINS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'FULL_REGEXP' | 'PARTIAL_REGEXP' — The match type for this filter.
        - `value` string — The string value used for the matching.
      - `betweenFilter` GoogleAnalyticsAdminV1betaAccessBetweenFilter — To express that the result needs to be between two numbers (inclusive).
        - `fromValue` GoogleAnalyticsAdminV1betaNumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
        - `toValue` GoogleAnalyticsAdminV1betaNumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
      - `inListFilter` GoogleAnalyticsAdminV1betaAccessInListFilter — The result needs to be in a list of string values.
        - `caseSensitive` boolean — If true, the string value is case sensitive.
        - `values` string[] — The list of string values. Must be non-empty.
      - `fieldName` string — The dimension name or metric name.
      - `numericFilter` GoogleAnalyticsAdminV1betaAccessNumericFilter — Filters for numeric or date values.
        - `value` GoogleAnalyticsAdminV1betaNumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
        - `operation` 'OPERATION_UNSPECIFIED' | 'EQUAL' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL' — The operation type for this filter.
  - `dimensions` GoogleAnalyticsAdminV1betaAccessDimension[] — The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
    - `dimensionName` string — The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`.
  - `timeZone` string — This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".

## Response `200`

Successful response

---

[API](https://skmtc.dev/google/apis/analyticsadmin.md) · [All operations](https://skmtc.dev/google/apis/analyticsadmin/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/analyticsadmin/revisions/ec5f6df9b9a2/schema)