Newer Version Available

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

Dashboard Saved Views List Resource

Returns a list of dashboard saved views or creates a single view.
Resource URL
1/wave/dashboards/<dashboardIdOrApiName>/savedviews
Formats
JSON
Available Version
42.0
HTTP Methods
GET POST
GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
type Connect​Wave​Dashboard​Saved​View​Type The type of saved view.
  • Shared
  • User
Required 42.0

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

1/wave/dashboards/<dashboardIdOrApiName>/savedviews?type=User
GET Response Body
Property Name Type Description Filter Group and Version Available Version
saved​Views Dashboard​Saved​View​Representation[] A collection of dashboard saved views. Small, 42.0 42.0
POST Request Body(Dashboard​Saved​View​Input​Representation)
Property Name Type Description Required or Optional Available Version
is​Initial Boolean Indicates whether the view is the initial view when loading the dashboard or not. Optional 42.0
label String The saved view label. Required 42.0
pageId String The dashboard page id this saved view applies to. Required 42.0
state Dashboard​Saved​View​State​Input​Representation The selections and filters to apply to the dashboard. Required 42.0
type Connect​Wave​Dashboard​Saved​View​Type The type of saved view.
  • Shared
  • User
Optional 42.0
POST Response Body (DashboardSavedViewRepresentation)
Property Name Type Description Filter Group and Version Available Version
id String The saved view id. Small, 42.0 42.0
is​Initial Boolean Indicates whether the view is the initial view when loading the dashboard or not. Small, 42.0 42.0
label String The saved view label. Small, 42.0 42.0
page​Id String The id of dashboard page this saved view loads on the dashboard. Small, 42.0 42.0
state Dashboard​Saved​View​State​Representation The selections and filters that were applied directly to the dashboard. Big, 42.0 42.0
type Connect​Wave​Dashboard​Saved​View​Type The type of saved view.
  • Shared
  • User
Small, 42.0 42.0
DashboardSavedViewStateInputRepresentation
Property Name Type Description Required or Optional Available Version
datasets Map<String, Dashboard​Saved​View​Dataset​State​Input​Representation> Map of the fully qualified dataset names to dataset state. Required 42.0
steps Map<String, Dashboard​Saved​View​Step​State​Input​Representation> Map of the step ids to step state. Required 42.0
DashboardSavedViewDatasetStateInputRepresentation
Property Name Type Description Required or Optional Available Version
filter Dashboard​Saved​View​Filter​Input​Representation The filter values. Required 42.0
type Connect​Wave​Dashboard​Saved​View​Dataset​State​Type The type of dataset type. Valid values are:
  • Global
Required 42.0
DashboardSavedViewStepStateInputRepresentation
Property Name Type Description Required or Optional Available Version
metadata Dashboard​Saved​View​Step​Metadata​Input​Representation The step metadata. Required 42.0
values Object[] The list of step values. Required 42.0
DashboardSavedViewFilterInputRepresentation
Property Name Type Description Required or Optional Available Version
operator String The filter operator. Required 42.0
values Object[] The list of filter values. Required 42.0
DashboardSavedViewStepMetadataInputRepresentation
Property Name Type Description Required or Optional Available Version
groups String[] The list of groups step metadata. Required 42.0
DashboardSavedViewStateRepresentation
Property Name Type Description Filter Group and Version Available Version
datasets Map<String, Dashboard​Saved​View​Dataset​State​Representation> Map of the fully qualified dataset names to dataset state. Small, 42.0 42.0
steps Map<String, Dashboard​Saved​View​Step​State​Representation> Map of the step ids to step state. Small, 42.0 42.0
DashboardSavedViewDatasetStateRepresentation
Property Name Type Description Filter Group and Version Available Version
fields String[] The dataset fields with filter or selection values. Small, 42.0 42.0
filter Dashboard​Saved​View​Filter​Representation The filter values. Small, 42.0 42.0
type Connect​Wave​Dashbhoard​Saved​View​Dataset​State​Type The type of dataset type. Valid values are:
  • Global
Small, 42.0 42.0
DashboardSavedViewStepStateRepresentation
Property Name Type Description Filter Group and Version Available Version
metadata Dashboard​Saved​View​Step​Metadata​Representation The step metadata. Small, 42.0 42.0
values Object[] The list of step values. Small, 42.0 42.0
DashboardSavedViewFilterRepresentation
Property Name Type Description Filter Group and Version Available Version
operator String The filter operator. Small, 42.0 42.0
values Object[] The list of filter values. Small, 42.0 42.0
DashboardSavedViewStepMetadataRepresentation
Property Name Type Description Filter Group and Version Available Version
groups String[] The list of groups step metadata. Small, 42.0 42.0