Dashboard - Fetch list of all available dashboards

Retrieves a list of all available dashboards.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Responses

200

Success: Successfully retrieved the list of dashboards.

text/plainapplication/jsontext/json

Class for Storing details about assets fetched from database.

tenantIdstring · uuidOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the TenantId property.

assetIdstring · uuidOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the AssetId property.

assetTypestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the AssetType property.

assetNamestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the AssetName property.

embedUrlstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the EmbedUrl property.

webUrlstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the WebUrl property.

datasetIdstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the DatasetId property.

bindedDatasetIdstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the BindedDatasetId property.

Default: null

reportTypestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ReportType property.

isEffectiveIdentityRolesRequiredstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the IsEffectiveIdentityRolesRequired property.

isEffectiveIdentityRequiredstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the IsEffectiveIdentityRequired property.

isReportTemplatebooleanOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the IsReportTemplates property.

canViewbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanView property.

canCreatebooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanCreate property.

canEditbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanEdit property.

canExportbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanExport property.

createdOnstring · date-time · nullableOptional

A public property of type DateTime that has both a getter and a setter method, which allows for getting and setting the value of the CreatedOn property.

modifiedOnstring · date-time · nullableOptional

A public property of type DateTime that has both a getter and a setter method, which allows for getting and setting the value of the ModifiedOn property.

createdBystring · nullableOptional

A public property of type Guid that has both a getter and a setter method, which allows for getting and setting the value of the CreatedBy property.

modifiedBystring · nullableOptional

A public property of type Guid that has both a getter and a setter method, which allows for getting and setting the value of the ModifiedBy property.

folderIdstring · uuid · nullableOptional

A public property of type Guid that has both a getter and a setter method, which allows for getting and setting the value of the FolderId property.

descriptionstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the Description property.

exportMethodinteger · enumOptional

Defines the available export methods for an asset.

Possible values:

paginatedAssetIdstring · uuid · nullableOptional

Gets or sets the unique identifier for the paginated asset. Required in case of Paginated visual export (type 2) MAQ.BIHub.API.Model.ReportsFromDb.ExportMethod

isHiddenbooleanOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the IsHidden property.

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

403

Forbidden: Access denied to view the list of dashboards due to insufficient permissions or account restrictions.

text/plainapplication/jsontext/json

404

Not Found: The Dashboard was not found, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

get

/dashboards

HTTPcURLJavaScriptPython

GET /dashboards HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  "assetId": "123e4567-e89b-12d3-a456-426614174000",
  "assetType": "text",
  "assetName": "text",
  "embedUrl": "text",
  "webUrl": "text",
  "datasetId": "text",
  "bindedDatasetId": "text",
  "reportType": "text",
  "reportPages": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "isEffectiveIdentityRolesRequired": "text",
  "isEffectiveIdentityRequired": "text",
  "isReportTemplate": true,
  "canView": true,
  "canCreate": true,
  "canEdit": true,
  "canExport": true,
  "createdOn": "2026-02-23T10:08:29.236Z",
  "modifiedOn": "2026-02-23T10:08:29.236Z",
  "createdBy": "text",
  "modifiedBy": "text",
  "reportParameter": [
    {
      "columnName": "text",
      "columnLabel": "text"
    }
  ],
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "exportMethod": 0,
  "paginatedAssetId": "123e4567-e89b-12d3-a456-426614174000",
  "isHidden": true
}