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
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

Templates List Resource

Returns a list of Analytics templates, or creates a template.
Resource URL
Formats
JSON
Available Version
36.0
HTTP Methods
GET POST
GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
type Connect​Wave​Template​Type​Enum The template type. Valid values are:
  • App
  • Dashboard
  • Embedded
  • Lens
 Required 36.0
GET Response Body
Property Name Type Description Filter Group and Version Available Version
templates Template​Representation[] The collection of application templates available within this organization. Small, 36.0 36.0
POST Request Body (TemplateInputRepresentation)

TemplateInputRepresentation inherits properties from the abstract BaseAssetInputRepresentation. These base properties appear in TemplateInputRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Required or Optional Available Version
dataflow Asset​Reference​Input​Representation The dataflow associated with this app. Optional 39.0
folder​Source Asset​Reference​Input​Representation The folder from which this template is created from. Required 39.0
POST Response Body (TemplateRepresentation)
Property Name Type Description Filter Group and Version Available Version
asset​Icon String The icon that best represents the Analytics application. Small, 36.0 36.0–41.0
asset​Version Double The asset version (API version) of all the dashboards and lenses. Big, 37.0 37.0
configuration​Url String The URL to the configuration of the template. Small, 36.0 36.0
custom​Attributes Template​Custom​Attributes​Representation The custom attribute definitions of the template. Big, 44.0 44.0
description String The description of the template. Big, 36.0 36.0
folder​Source Asset​Reference​Representation The folder source of the template Medium, 39.0 39.0
icons Template​Icons​Representation The icons configured for the template. Small, 41.0 41.0
id String The ID or fully qualified API name of the template. Small, 36.0 36.0
label String The localized name of the application template. Small, 36.0 36.0
name String The local API name of the template. Medium, 36.0 36.0
namespace String The namespace of the template provider. Medium, 36.0 36.0
release​Info Template​Release​Representation The release information for the template Medium, 37.0 37.0
tags String[] A list of tag definitions for the template. Big, 44.0 44.0
template​Icon String The icon that best represents the Analytics application template. Small, 36.0 36.0–41.0
template​Type Connect​Wave​Template​Type​Enum The template type. Valid values are:
  • App
  • Dashboard
  • Embedded
  • Lens
 Small, 36.0 36.0
url String The URL to the detail of the template. Small, 36.0 36.0
videos Video​Info​Representation The videos associated with the template. Big, 46.0 46.0