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 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
Dataflow Jobs List Resource
Dataflow Jobs Resource
Dataflows List Resource
Dataflows 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

Lens File Metadata Resource

Resource for management of Analytics lens file metadata.
Resource URL
1/wave/lenses/<lens Id or Api Name>/files
Formats
JSON
Available Version
36.0
HTTP Methods
GET POST
GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
page String 36.0
pageSize Int 36.0
GET Response Body
Get a collection of Analytics lens file metadata.
Property Name Type Description Filter Group and Version Available Version
files Wave​File​Metadata​Representation[] List of file metadata. Small, 36.0 36.0
nextPageUrl String URL to get the next page of contents in the collection. Small, 36.0 36.0
totalSize Integer Gets the total count of the elements in the collection irrespective of the page. Medium, 36.0 36.0
url String URL to get the collection. Small, 36.0 36.0
WaveFileMetadataRepresentation
Property Name Type Description Filter Group and Version Available Version
createdBy Wave​User​Representation created by user Medium, 36.0 36.0
createdDate Date created date Medium, 36.0 36.0
id String The 18 character lens file ID. Small, 36.0 36.0
last​Accessed​Date Date last accessed date Medium, 36.0 36.0
last​Modified​Date Date last modified date Medium, 36.0 36.0
length Integer size of the lens file Small, 36.0 36.0
name String name of lens file Small, 36.0 36.0
url String url of file. Small, 36.0 36.0
WaveUserRepresentation
Property Name Type Description Filter Group and Version Available Version
id String The 18 character user ID. Small, 36.0 36.0
name String The name of the user. Small, 36.0 36.0
profile​Photo​Url String The Chatter profile photo of the user. Small, 36.0 36.0
POST Request Parameters
Parameter Name Type Description Required or Optional Available Version
previewFile Binary 36.0
POST Response Body
Creates lens file.
Property Name Type Description Filter Group and Version Available Version
createdBy Wave​User​Representation created by user Medium, 36.0 36.0
createdDate Date created date Medium, 36.0 36.0
id String The 18 character lens file ID. Small, 36.0 36.0
last​Accessed​Date Date last accessed date Medium, 36.0 36.0
last​Modified​Date Date last modified date Medium, 36.0 36.0
length Integer size of the lens file Small, 36.0 36.0
name String name of lens file Small, 36.0 36.0
url String url of file. Small, 36.0 36.0