Dashboards List Resource

Returns a list of Analytics dashboards, or creates a dashboard.

Resource URL

1/wave/dashboards

Formats

JSON

Available Version

36.0

HTTP Methods

GET POST

GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`folderId`	ID	Filters the results to include only the contents of a specific folder. Can be the requesting user’s ID for items in the user’s private folder.		36.0
`page`	String	A generated token that indicates the view of dashboards to be returned.		36.0
`pageSize`	Int	Number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.		36.0
`q`	String	Search terms. Individual terms are separated by spaces. Wild cards aren’t supported.		36.0
`sort`	Enum	Sort order of the results. Values are: `LastModified` `Mru`: Most recently used (last viewed date) `Name` The default value is `Mru`.	Optional	36.0

GET Response Body

Property Name	Type	Description	Filter Group and Version	Available Version
`dashboards`	Dashboard Representation[]	A collection of Analytics dashboards.	Small, 36.0	36.0
`nextPageUrl`	String	The URL to retrieve the next page of contents in the collection.	Small, 36.0	36.0
`totalSize`	Integer	The total count of the elements in the collection, including all pages.	Medium, 36.0	36.0
`url`	String	The URL to retrieve the collection.	Small, 36.0	36.0

POST Request Body

DashboardInputRepresentation

POST Response Body

Dashboard Representation

Example Response Body

1{
2    "dashboards": [ "/* Dashboard detail omitted for brevity. */"],
3    "nextPageUrl": "/services/data/v36.0/wave/dashboards?page=eyJwYWdlU2lSI6UsInNv",
4    "totalSize": 33,
5    "url": "/services/data/v36.0/wave/dashboards/0FKD00000004Cb8OAE"
6}

Analytics REST API Developer Guide

Dashboards List Resource