/api/dashboards/:id
Shows detailed information about the dashboard with the specified ID.
Resource Information
Resource URL | |
---|---|
HTTP Method |
|
Request Parameters
Parameters | Detail | Example |
---|---|---|
| ID of the dashboard to fetch. You can find the ID in the response to | 123 |
Response Structure
JSON response contains one JSON object with following elements:
Name | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Dashboard identifier | ||||||||||||||||||||||||||||||||
name | Dashboard name | ||||||||||||||||||||||||||||||||
description | Dashboard description | ||||||||||||||||||||||||||||||||
dashlets | Array of views where each dashlet has following structure:
|
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/123
The JSON format response:
{ "id": 123, "name": "My Dashboard", "description" : "This is my dashboard.", "dashlets": [ { "name": "First Dashlet", "type": "viewReport", "canAccessViewReport": true, "viewReport": { "id": 88739, "name": "Sales by User", "type": "chart", "filter": { "drilldown": { "L_USER": { "values": [ "john" ], "op": "IN" } } } } }, { "name": "Second Dashlet", "type": "textContent", "textContent": "My text content" } ] }
Overview
Content Tools