/api/dashboards
Lists all dashboards available to the user.
Resource Information
Resource URL | |
---|---|
HTTP Method |
|
Request Parameters
Parameters | Detail | Example |
---|---|---|
| (Optional) If set, the result only contains dashboards that contain the filter text in their name. | Sales |
| (Optional) Specifies the page offset if pagination is necessary. | 2 |
| (Optional) Specifies the number of entries on each page if pagination is necessary. | 15 |
Response Structure
{ "dashboards" : [ ], "offset" : 0, "size" : 100 }
JSON response contains 2 pagination elements (offset and size) but the main element is array "dashboards" that contains multiple dashboard objects with following definition:
Name | Description |
---|---|
id | Dashboard identifier |
name | Dashboard name |
description | Dashboard description |
lastChange | Date and time of dashboard last change |
localization | Localization object that contains key-value pairs, where key is code of supported language and value is localized dashboard name. |
Sample Request / Response
Using curl
:
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/dashboards?filter=my
The JSON format response:
{ "dashboards": [ { "id": 12149, "name": "My Dashboard", "localization" : { "de" : "Deutsch Name" }, "description" : "This is my description.", "lastChange": "Fri, 16 Aug 2013 14:49:02 GMT" } ], "offset": 0, "size": 100 }
Overview
Content Tools