EmbedFAST: Technical Documentation

CtrlK

Dataset - Fetch list of all available datasets

Retrieves a list of all available datasets.

get

Authorizations

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 available datasets.

403

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

404

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

500

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

get

GET /datasets HTTP/1.1
Host: 
Authorization: Bearer JWT
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-09-05T22:42:10.632Z",
  "modifiedOn": "2025-09-05T22:42:10.632Z",
  "createdBy": "text",
  "modifiedBy": "text",
  "reportParameter": [
    {
      "columnName": "text",
      "columnLabel": "text"
    }
  ],
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text"
}

Retrieves a comprehensive list of all available assets in the system.

get

Authorizations

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Responses

200

Success: Successfully retrieved the existing assets-related details.

400

Bad Request: The request is invalid due to syntax errors or incorrect/missing parameters.

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

500

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

get

GET /assets HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "reports": [
    {
      "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-09-05T22:42:10.632Z",
      "modifiedOn": "2025-09-05T22:42:10.632Z",
      "createdBy": "text",
      "modifiedBy": "text",
      "reportParameter": [
        {
          "columnName": "text",
          "columnLabel": "text"
        }
      ],
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text"
    }
  ],
  "dashboards": [
    {
      "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-09-05T22:42:10.632Z",
      "modifiedOn": "2025-09-05T22:42:10.632Z",
      "createdBy": "text",
      "modifiedBy": "text",
      "reportParameter": [
        {
          "columnName": "text",
          "columnLabel": "text"
        }
      ],
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text"
    }
  ],
  "datasets": [
    {
      "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-09-05T22:42:10.632Z",
      "modifiedOn": "2025-09-05T22:42:10.632Z",
      "createdBy": "text",
      "modifiedBy": "text",
      "reportParameter": [
        {
          "columnName": "text",
          "columnLabel": "text"
        }
      ],
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text"
    }
  ]
}

Last updated 2 months ago