/api/dashboards/:id

Shows detailed information about the dashboard with the specified ID.

Resource Information

Resource URL

https://service.belladati.com/api/dashboards/:id

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

id

ID of the dashboard to fetch. You can find the ID in the response to /api/dashboards.

123

Response Structure

JSON response contains one JSON object with following elements:

NameDescription
idDashboard identifier
nameDashboard name
descriptionDashboard description
dashlets

Array of views where each dashlet has following structure:

NameDescription
nameDashlet name
typeDashlet type - please see list of supported values.
viewReport

Only if "type" has value "viewReport". View report definition with following structure:

NameDescription
idView identifier
nameView name
typeView type - please see list of supported values.
filter

(Optional) Applied filter with following structure:

Name
Description
drilldown

Drilldown defined with attribute code and following structure:

Name
Description
opFilter operation type - please see list of supported values.
value/values(Optional) Depends on selected "op". Contains value or values for filter.



canAccessViewReportOnly if "type" has value "viewReport". Boolean flag indicating if view report is accessible.
textContentOnly if "type" has value "textContent". Content of a text dashlet.


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"
    }
  ]
}
  • No labels