Dashboard - Fetch details of any requested dashboard

Retrieves detailed information about a specific dashboard identified by its unique ID.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

dashboardIdstring · uuidRequired

Enter ID of an existing dashboard.

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Responses

200

Success: Successfully retrieved details of the requested dashboard.

text/plainapplication/jsontext/json

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 due to insufficient permissions or account restrictions for the given ID.

text/plainapplication/jsontext/json

404

Not Found: The dashboard with the provided ID does not exist, 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/{dashboardId}

HTTPcURLJavaScriptPython

GET /dashboards/{dashboardId} HTTP/1.1
Host: 
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": "2025-12-16T15:15:35.837Z",
  "modifiedOn": "2025-12-16T15:15:35.837Z",
  "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"
}