Returns a list of acceptable dashboards (requires READ permission to the dashboards)

Returns a list of acceptable dashboards (requires READ permission to the dashboards)

cURL

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/dashboards \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "content": [
    {
      "name": "<string>",
      "id": "<string>",
      "description": "<string>",
      "layout": "<string>",
      "dashboardLayout": {},
      "icon": "<string>",
      "showDescription": true,
      "isReportDashboard": true,
      "unifiedBarCfgs": [
        {
          "id": "<string>",
          "accountId": "<string>",
          "timeControlCfg": {
            "timeField": "<string>",
            "from": "<string>",
            "to": "<string>",
            "calendarId": "<string>"
          },
          "playerControlCfg": {
            "timeWindowScale": "PINNED",
            "pauseAfterRead": true,
            "stopTime": "<string>",
            "speed": 123
          },
          "sharpeningCfg": {
            "prefer": true,
            "maxQueries": 123
          },
          "widgetIds": [
            "<string>"
          ]
        }
      ],
      "selectedWidgetId": "<string>",
      "fieldLinks": [
        {
          "id": "<string>",
          "label": "<string>",
          "mappings": [
            {
              "fieldName": "<string>",
              "sourceId": "<string>",
              "fieldType": "<string>"
            }
          ]
        }
      ],
      "rowFilters": [
        {
          "sourceId": "<string>",
          "path": "<string>",
          "form": "<string>",
          "operation": "EQUALS",
          "value": "<unknown>",
          "custom": {},
          "label": "<string>"
        }
      ],
      "mutedLinks": [
        {
          "targetId": "<string>",
          "widgetId": "<string>",
          "direction": "publish, subscribe",
          "type": "crossSource, sameSource"
        }
      ],
      "creatorName": "<string>",
      "creatorFullName": "<string>",
      "widgets": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "header": {
            "visibility": "VISIBLE"
          },
          "layout": {
            "col": 123,
            "row": 123,
            "rowSpan": 123,
            "colSpan": 123
          },
          "position": {
            "relativeHeight": 123,
            "relativeWidth": 123,
            "verticalPosition": "<string>",
            "horizontalPosition": "<string>"
          },
          "visualId": "<string>",
          "dashboardLink": {
            "dashboardId": "<string>",
            "dashboardName": "<string>",
            "inheritFilterCfg": true
          },
          "content": {
            "contentType": "VISUAL",
            "visualId": "<string>",
            "snippetId": "<string>"
          },
          "pickers": {
            "hiddenPickers": [
              "<string>"
            ],
            "visibility": "CUSTOM"
          }
        }
      ],
      "tags": [
        "<string>"
      ],
      "interactivityProfile": {
        "name": "<string>",
        "type": "SYSTEM",
        "overrideVisualInteractivity": true,
        "settings": {},
        "visualSettings": {}
      },
      "originId": "<string>",
      "projectId": 2222,
      "folderId": 1111,
      "reportDetails": {
        "reportType": "RAW_DATA_TABLE",
        "id": "<string>"
      },
      "createdByUserID": "<string>",
      "lastModifiedByUserID": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "lastModifiedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "otherDashboardsExist": true,
  "pageInfo": {
    "nextPageToken": "<string>",
    "previousPageToken": "<string>"
  }
}

Authorizations

Authorization · string · header · required

HTTP Basic authentication using global administrator credentials (username and password).

Query Parameters

sourceId · string

deprecated since 23.3, will be removed in future releases. Use filters parameter

visualizationId · string

deprecated since 23.3, will be removed in future releases. Use filters parameter

fields · string

Defines field of a dashboard to be returned

includeFieldLinks · boolean · default: false

Enables field links in the dashboard response

maxResults · integer<int32> · default: 0

Required range: x >= 0

pageToken · string

filter · string

Defines filter to search by. SourceId and visualizationId should not work with combination of filter. Supports only boolean, string, number, date time literal types on primary fields like name, id, description etc. Operators supported are =, != or <>, like, ilike, >, >=, <, <=, is null, is not null, in, and, or, not, is empty, is not empty. Tag supports in, and, is empty, is not empty, not operators. Other operators might not return expected result. Nested objects, array properties are not supported.

sort · string

Defines sort order for results. Supports only primary fields like name, id, description etc with direction ASC or DESC. Nested objects, array properties are not supported.(Example: tags)

Response

200

application/vnd.composer.v3+json

The dashboards were retrieved successfully

Defines a list of dashboards

content · object[]

Show child attributes

otherDashboardsExist · boolean

Defines an existence of other dashboards in the account

pageInfo · object

Show child attributes