DataAnnotations
List all Reporting Data Annotations on a property.
View-Specific Information
Select
The provider uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
- Parent supports the following operator: =
- PropertyId supports the following operator: =
- Name supports the following operators: =, !=, LIKE, NOT LIKE, CONTAINS, NOT CONTAINS
- Title supports the following operators: =, !=, LIKE, NOT LIKE, CONTAINS, NOT CONTAINS
- Description supports the following operators: =, !=, LIKE, NOT LIKE, CONTAINS, NOT CONTAINS
- Color supports the following operators: =, !=
- StartDate supports the following operator: =
- EndDate supports the following operator: =
The API requires that at least one of the following columns must be specified: Name, Parent, or PropertyId.
For example, the following queries are processed server-side:
SELECT * FROM DataAnnotations WHERE parent = 'properties/309787233';
SELECT * FROM DataAnnotations WHERE name = 'properties/309787233/keyEvents/7710067029';
SELECT * FROM DataAnnotations WHERE propertyid=213025502 AND Title != 'New: Data not available' AND Description like '%measu_ement%';
SELECT * FROM DataAnnotations WHERE propertyid=213025502 AND StartDate = '2025-03-27' AND endDate = '2025-12-31';
The provider processes other filters client-side.
Columns
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Name [KEY] | String | Resource name of this Reporting Data Annotation. | |||
| Parent | String | Name of the Data Annotations's logical parent. | |||
| PropertyId | Integer | Property ID value to be used when querying this table. | |||
| Title | String | Human-readable title for this Reporting Data Annotation. | |||
| Description | String | Description for this Reporting Data Annotation. | |||
| Color | String | The color used for display of this Reporting Data Annotation. Possible values are: COLOR_UNSPECIFIED, PURPLE, BROWN, BLUE, GREEN, RED, CYAN, ORANGE. | |||
| SystemGenerated | Boolean | If true, this annotation was generated by the Google Analytics system. | |||
| AnnotationDate | String | Reporting Data Annotation is for a specific date represented by this field. | |||
| AnnotationDateRange | String | Reporting Data Annotation is for a range of dates represented by this field. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| StartDate | Date | The Annotation start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future. Example: 2025-04-07 |
| EndDate | Date | The Annotation end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date. Example: 2025-04-07 |