Method: properties.reportingDataAnnotations.list

  • Use a GET request to list all Reporting Data Annotations for a specific property.

  • The request requires a parent path parameter specifying the property resource name.

  • Optional query parameters like filter, pageSize, and pageToken can be used to refine the results.

  • The response body contains a list of Reporting Data Annotations and a token for pagination.

  • Authorization requires either the analytics.readonly or analytics.edit OAuth scope.

List all Reporting Data Annotations on a property.

HTTP request

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource name of the property. Format: properties/property_id Example: properties/123

Query parameters

Parameters
filter

string

Optional. Filter that restricts which reporting data annotations under the parent property are listed.

Supported fields are:

  • 'name'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

Additionally, this API provides the following helper functions:

  • annotation_duration() : the duration that this annotation marks, durations. expect a numeric representation of seconds followed by an s suffix.
  • is_annotation_in_range(startDate, endDate) : if the annotation is in the range specified by the startDate and endDate. The dates are in ISO-8601 format, for example 2031-06-28.

Supported operations:

  • = : equals
  • != : not equals
  • < : less than
  • > : greater than
  • <= : less than or equals
  • >= : greater than or equals
  • : : has operator
  • =~ : regular expression match
  • !~ : regular expression does not match
  • NOT : Logical not
  • AND : Logical and
  • OR : Logical or

Examples:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
pageSize

integer

Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
pageToken

string

Optional. A page token, received from a previous reportingDataAnnotations.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to reportingDataAnnotations.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for ListReportingDataAnnotation RPC.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Fields
reportingDataAnnotations[]

object (ReportingDataAnnotation)

List of Reporting Data Annotations.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit