Annotations
Retrieve, create, or update annotations defined within your Adobe Analytics environment.
Columns
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Id [KEY] | String | Unique identifier of the annotation. | ||||
| Name | String | The name of the annotation. | ||||
| Description | String | A description for the annotation. | ||||
| DateRange | String | The date range for the annotation, formatted as YYYY-MM-ddT00:00:00/YYYY-MM-ddT00:00:00. | ||||
| Color | String | The color assigned to the annotation. Possible values: STANDARD1 through STANDARD9, CUSTOM100 through CUSTOM109. | ||||
| ApplyToAllReports | Boolean | Whether the annotation applies to all report suites. | ||||
| Scope | String | The scope of the annotation, e.g. HIT. | ||||
| Rsid | String | The report suite ID for the annotation. | ||||
| ReportSuiteName | String | The name of the report suite the annotation belongs to. | ||||
| CreatedDate | Datetime | The datetime the annotation was created. | ||||
| ModifiedDate | Datetime | The datetime the annotation was last modified. | ||||
| ModifiedById | String | Unique identifier of the user that lastly modified the annotation. | ||||
| OwnerId | String | Unique identifier of the user that created the annotation. | ||||
| OwnerName | String | Name of the user that created the annotation. | ||||
| OwnerLogin | String | Login of the user that created the annotation. | ||||
| CompanyId | String | The company ID associated with the annotation. | ||||
| Tags | String | Tags associated with the annotation as a JSON array. | ||||
| Shares | String | Shares associated with the annotation as a JSON array. | ||||
| Approved | Boolean | Whether the annotation is approved. | ||||
| Favorite | Boolean | Whether the annotation is marked as a favorite. | ||||
| UsageSummary | String | Usage summary associated with the annotation as a JSON object. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| IncludeType | String | A comma-separated list of additional annotation types to include. Possible values: shared, all. |
| Locale | String | The locale for returning results, e.g. en_US. |