Analytics REST API Developer Guide

Working with the Analytics REST API
Analytics REST API Reference
Analytics REST API Resources Overview
Wave Resource
Annotations List Resource
Annotation Resource
Charts Geodata List Resource
Charts Geodata Resource
Charts Geodata File List Resource
Charts Maps List Resource
Charts Maps Resource
Dashboards List Resource
Dashboard Resource
Dashboard Image Resource
Data Connector Resource
Data Connectors List Resource
Data Connector Source Objects List Resource
Data Connector Source Object Resource
Data Connector Source Object Data Resource
Data Connector Source Object Data Preview Resource
Data Connector Source Object Fields Resource
Data Connector Types Resource
Datasets List Resource
Dataset Resource
Dependencies Resource
Features Configuration Resource
File Resource
Folders List Resource
Folder Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Query Resource
Recipes List Resource
Recipe Resource
Recipe File Resource
Replicated Datasets Resource
Replicated Datasets List Resource
Replicated Dataset Fields Resource
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Templates List Resource
Templates Resource
Templates Configuration Resource
Template Release Notes Resource
Trended Reports List Resource
Trended Reports Resource
Dataset Versions List Resource
Dataset Version Resource
XMD List Resource
XMD Resource
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Annotation Resource

An asset's annotations.
Resource URL
1/wave/annotations/<Annotation ID>
Formats
JSON
Available Version
37.0
HTTP Methods
GET PATCH
GET Response Body
AnnotationRepresentation
Property Name Type Description Filter Group and Version Available Version
anchor String The anchor key. Small, 37.0 37.0
asset Asset​Reference​Representation The referenced asset. Small, 37.0 37.0
feedElement Asset​Reference​Representation The referenced feed element. Small, 37.0 37.0
id String The 18 character annotation ID. Small, 37.0 37.0
resolved Boolean The resolved state of the annotation. Small, 37.0 37.0
url String URL to get this annotation. Small, 37.0 37.0
PATCH Request Body
AnnotationInputRepresentation
Property Name Type Description Required or Optional Available Version
anchor String The anchor of the annotation. Optional 37.0
asset Asset​Reference​Input​Representation The referenced asset of the annotation. Required 37.0
feedElement Asset​Reference​Input​Representation The referenced feed element of the annotation. Required 37.0
resolved Boolean The resolved state of the annotation. Optional 37.0
PATCH Response Body
AnnotationRepresentation