Import dashboards

Import dashboards

cURL

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/dashboards/import \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "version": "<string>",
  "dashboards": [
    {
      "name": "<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": {
            "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>",
          "value": "<unknown>",
          "custom": {},
          "label": "<string>"
        }
      ],
      "mutedLinks": [
        {
          "targetId": "<string>",
          "widgetId": "<string>",
          "direction": "publish, subscribe",
          "type": "crossSource, sameSource"
        }
      ],
      "widgets": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "header": {},
          "layout": {
            "col": 123,
            "row": 123,
            "rowSpan": 123,
            "colSpan": 123
          },
          "position": {
            "relativeHeight": 123,
            "relativeWidth": 123,
            "verticalPosition": "<string>",
            "horizontalPosition": "<string>"
          },
          "visualId": "<string>",
          "pickers": {
            "hiddenPickers": [
              "<string>"
            ]
          }
        }
      ],
      "tags": [
        "<string>"
      ],
      "originId": "<string>",
      "folderId": 1111
    }
  ],
  "importSettings": {
    "objectClassLevel": {},
    "objectLevel": {
      "visuals": {},
      "connections": {},
      "sources": {},
      "dashboards": {}
    },
    "warningTags": [
      "<string>"
    ]
  },
  "connections": [
    {
      "name": "<string>",
      "type": "<string>",
      "subStorageType": "<string>",
      "id": "<string>",
      "accountId": "<string>",
      "creatingUserName": "<string>",
      "disabled": true,
      "connectionTypeId": "<string>",
      "allParameters": [
        {
          "key": "<string>",
          "value": "<string>",
          "isSystemAccess": true,
          "systemAccess": true
        }
      ],
      "folderId": 1111
    }
  ],
  "visualTypes": [
    {
      "visualTypeId": "<string>",
      "name": "<string>",
      "type": "<string>",
      "enabled": true,
      "restriction": {
        "value": "<unknown>",
        "custom": {},
        "label": "<string>",
        "path": "<string>"
      }
    }
  ],
  "sources": [
    {
      "fields": [
        {
          "origin": {
            "derivedOrigin": {
              "expression": "sales * 100",
              "calendarId": "<string>",
              "referencedFieldNames": [
                "<string>"
              ]
            }
          },
          "name": "field_name",
          "label": "Field Label",
          "visible": true,
          "format": {
            "time": {
              "timeZone": "UTC",
              "options": {
                "hour12": true
              }
            }
          },
          "statistics": {
            "override": {
              "min": 123,
              "max": 123,
              "distinctValues": [
                "<unknown>"
              ]
            },
            "cacheEnabled": true,
            "refreshable": true,
            "cardinality": 123
          },
          "facetFiltering": {
            "enabled": true,
            "order": 2
          },
          "disabledCapabilities": [
            "<string>"
          ],
          "fieldMetadata": {},
          "rawFormatSupportTimeGroup": true,
          "fieldName": "<string>",
          "originalFieldName": "<string>"
        }
      ],
      "customMetrics": [
        {
          "expression": "SUM(sales_in_usd) + SUM(sales_in_uah) * uah_to_usd_exchange_rate",
          "name": "sum_of_sales",
          "label": "Sum of Sales",
          "visible": true,
          "timeFormat": {
            "timeZone": "UTC",
            "options": {
              "hour12": true
            }
          }
        }
      ],
      "globalSettings": {
        "textSearchEnabled": true,
        "timebar": {
          "enabled": true,
          "from": "<string>",
          "to": "<string>",
          "calendarId": "<string>",
          "timeField": "<string>",
          "sharpening": {
            "enabled": true,
            "maxQueries": 123
          },
          "player": {
            "enabled": true,
            "live": {
              "delay": 123,
              "refreshRate": 123
            }
          }
        },
        "tileProvider": {
          "name": "<string>",
          "apiKey": "<string>",
          "url": "<string>",
          "mapBoxStyleId": "<string>"
        },
        "defaultVisualFilters": [
          {
            "sourceId": "<string>",
            "path": "<string>",
            "form": "<string>",
            "value": "<unknown>",
            "custom": {},
            "label": "<string>"
          }
        ],
        "allowedCalendarIds": [
          "<string>"
        ]
      },
      "cacheSettings": {
        "dataCache": {
          "enabled": true,
          "evictionStrategy": {
            "ttl": 123
          }
        },
        "statisticsCache": {
          "enabled": true,
          "evictionStrategy": {
            "ttl": 123
          }
        }
      },
      "uniqueKey": [
        "<string>"
      ],
      "enabledSourceVisualTypes": [
        {
          "visualTypeId": "<string>",
          "name": "<string>",
          "type": "<string>",
          "enabled": true,
          "restriction": {
            "value": "<unknown>",
            "custom": {},
            "label": "<string>",
            "path": "<string>"
          }
        }
      ]
    }
  ],
  "visuals": [
    {
      "visualName": "<string>",
      "source": {
        "filters": [
          {
            "value": "<unknown>",
            "custom": {},
            "label": "<string>",
            "path": "<string>"
          }
        ],
        "aggregateFilters": [
          {
            "value": "<unknown>",
            "custom": {},
            "label": "<string>",
            "name": "<string>"
          }
        ],
        "sourceId": "<string>",
        "variables": {}
      },
      "visId": "<string>",
      "visualTypeId": "<string>",
      "description": "<string>",
      "type": "<string>",
      "controlsCfg": {
        "id": "<string>",
        "timeControlCfg": {
          "from": "<string>",
          "to": "<string>",
          "timeField": "<string>",
          "calendarId": "<string>"
        },
        "playerControlCfg": {
          "pauseAfterRead": true,
          "stopTime": "<string>",
          "speed": 123
        },
        "sharpeningCfg": {
          "prefer": true,
          "maxQueries": 123
        }
      },
      "interactivityProfile": {},
      "tags": [
        "<string>"
      ],
      "folderId": 1111
    }
  ],
  "snippets": [
    {
      "type": "TEXT",
      "data": {
        "markdown": "### Lorem ipsum dolor sit amet"
      }
    }
  ],
  "calendars": [
    {
      "type": "MONTH_SHIFT",
      "name": "Calendar name",
      "monthShift": -4
    }
  ]
}
'

200

{
  "dashboards": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "visuals": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "sources": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "uploads": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "visualTypes": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "snippets": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "calendars": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Query Parameters

accountId · string

Target Account

enableDefaultRead · boolean · default: false

Will enable data read permissions for sources imported for all the users in the tenant.

suppressWarnings · boolean · default: false

The response to this API endpoint may return a validation error with a list of problems. Each problem has a level (ERROR, WARNING). Passing suppressWarnings=true will suppress all warnings and the request will succeed if there were no errors.

Body

application/vnd.composer.v3+json

Defines a dashboard migration payload

version · string · required

Defines an application version

Minimum string length: 1

dashboards · object[] · required

Defines migrating dashboards

Minimum array length: 1

Show child attributes

importSettings · object

Defines import settings

Show child attributes

connections · object[]

Defines used connections

Show child attributes

visualTypes · object[]

Defines used visual types

Show child attributes

sources · object[]

Defines used sources

Show child attributes

visuals · object[]

Defines used visuals

Show child attributes

snippets · object[]

Defines used snippets

Show child attributes

calendars · object[]

Defines used calendars

Show child attributes

Response

200

application/vnd.composer.v3+json

The dashboard was imported

Defines result of dashboard import

dashboards · object[]

Defines imported dashboards

Show child attributes

visuals · object[]

Defines imported visuals

Show child attributes

sources · object[]

Defines imported sources

Show child attributes

uploads · object[]

Defines imported uploads

Show child attributes

visualTypes · object[]

Defines imported visual types

Show child attributes

connections · object[]

Defines imported connections

Show child attributes

snippets · object[]

Defines imported snippets

Show child attributes

calendars · object[]

Defines imported calendars

Show child attributes