Annotation definition data structure
The annotation definition data structure is used to communicate an annotation's structure to the API.
id
: The annotation's unique ID.name
: The name of the annotation.description
: The annotation's description.dateRange
: The date range of the annotation.color
: An enum representing the annotation's color. Supported values includeSTANDARD1
throughSTANDARD9
.applyToAllReports
: A boolean that determines if the annotation applies to all report suites.scope
: An object including themetrics
andfilters
that the annotation uses.createdDate
: The ISO 8601 date that the annotation was created.modifiedDate
: The ISO 8601 date that the annotation was last modified.modifiedById
: The ID of the user who last modified the annotation.tags
: The tags applied to the annotation.shares
: The shares applied to the annotation.approved
: A boolean that determines if the annotation is approved by an admin.favorite
: A boolean that determines if the user has this annotation favorited (starred).usageSummary
: An object that shows where this annotation is used.owner
: An object showing information of the user that created the annotation.imsOrgId
: The IMS org of the annotation.dataName
: The Data View name.rsid
: The Data View ID.
Example#
Copied to your clipboard1{2 "id": "string",3 "name": "string",4 "description": "string",5 "dateRange": "string",6 "color": "STANDARD1",7 "applyToAllReports": true,8 "scope": {9 "metrics": [10 {11 "id": "string",12 "componentType": "string"13 }14 ],15 "filters": [16 {17 "id": "string",18 "operator": "string",19 "dimensionType": "string",20 "terms": [21 "string"22 ],23 "componentType": "string"24 }25 ]26 },27 "createdDate": "YYYY-04-01T00:18:13.651Z",28 "modifiedDate": "YYYY-04-01T00:18:13.651Z",29 "modifiedById": "string",30 "tags": [31 {32 "additionalProp1": {},33 "additionalProp2": {},34 "additionalProp3": {}35 }36 ],37 "shares": [38 {39 "additionalProp1": {},40 "additionalProp2": {},41 "additionalProp3": {}42 }43 ],44 "approved": true,45 "favorite": true,46 "usageSummary": {47 "additionalProp1": {},48 "additionalProp2": {},49 "additionalProp3": {}50 },51 "owner": {52 "imsUserId": "string",53 "ownerId": "string",54 "name": "string",55 "type": "imsUser"56 },57 "imsOrgId": "string",58 "dataName": "string",59 "dataId": "string"60}