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
Dashboard Saved Views List Resource
Dashboard Saved Views Resource
Dashboard Saved Views Initial Resource
Data Connector Resource
Data Connectors List Resource
Data Connector Ingest Resource
Data Connector Source Objects List Resource
Data Connector Source Object Resource
Data Connector Source Object Data Preview Resource
Data Connector Source Object Fields Resource
Data Connector Status Resource
Data Connector Types Resource
Dataflow Jobs List Resource
Dataflow Job Resource
Dataflows List Resource
Dataflow Resource
Datasets List Resource
Dataset Resource
Dependencies Resource
Features Configuration 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
Recipe Notification Resource
Replicated Dataset Resource
Replicated Datasets List Resource
Replicated Dataset Fields Resource
Schedule Resource
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Templates List Resource
Template Resource
Template Configuration Resource
Template Release Notes Resource
Trended Reports List Resource
Trended Reports Resource
Dataset Versions List Resource
Dataset Version Resource
Dataset Version File Resource
XMD List Resource
XMD Resource
Asset XMD Resource
Additional Analytics REST API Resources
PDF

Newer Version Available

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

Annotations List Resource

Returns a list of annotations.
Resource URL
1/wave/annotations
Formats
JSON
Available Version
37.0
HTTP Methods
GET POST
GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
assetId Id The ID of the asset. Required 37.0

The following REST URL shows how to use the assetId parameter in the GET request.

1/wave/annotations?assetId=<id>
GET Response Body (AnnotationCollectionRepresentation)
Property Name Type Description Filter Group and Version Available Version
annotations Annotation​Representation[] The list of annotations for this asset and feedSubject. Small, 37.0 37.0
feed​Subject Asset​Reference​Representation The feed subject for all annotations. Small, 37.0 37.0
subscription​Id String The 18-character ID of the subscription. Small, 38.0 38.0
url String The URL to get this collection. Small, 37.0 37.0
POST 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
feed​Element Asset​Reference​Input​Representation The referenced feed element of the annotation. Required 37.0
resolved Boolean Indicates whether the state of the annotation is resolved or not. Optional 37.0
POST 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
feed​Element 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 Indicates whether the state of the annotation is resolved or not. Small, 37.0 37.0
url String The URL to get this annotation. Small, 37.0 37.0