Guandata Open Platform
8.2.0
  • 8.3.0
  • 8.2.0
HomeWebsiteChinese version
Docs
  • Help Center
  • Guandata Academy
HomeWebsiteChinese version
Docs
  • Help Center
  • Guandata Academy
8.2.0
  • 8.3.0
  • 8.2.0
  1. Developer Guide
  • Users
    • Batch Create Users
      POST
    • Batch Delete Users
      POST
    • Batch Update User Attributes
      POST
    • Batch Check if Users Exist
      POST
    • Get User List by Attribute Value
      POST
    • Get User List
      POST
    • Get User Information via loginId
      POST
    • Modify User Status
      POST
  • Developer Guide
    • Token Authentication
    • Common Concepts
  • Datasets
    • Update Dataset Using Parquet File
      GET
    • Get Dataset List
      POST
    • Modify Dataset Path
      POST
    • Delete Dataset
      POST
    • Search Dataset List
      POST
    • Query Dataset Schema
      POST
    • Batch Update Dataset Update Mode
      POST
    • Get Users with Access Permission for Specified Dataset
      POST
    • Upload Dataset
      POST
    • Get Dataset Download Authorization Token
      GET
    • Download Dataset Data
      POST
    • Get Dataset Data
      POST
    • Create Dataset
      POST
    • Update Dataset Field Comments
      POST
    • Trigger Dataset to Read Data File and Update
      GET
    • Query Dataset Update Result by TaskID
      GET
    • Modify Dataset Schema
      POST
    • Update Dataset
      POST
    • Modify Dataset Field Alias
      POST
    • Modify Dataset Name
      POST
    • Dataset Preview API
      POST
    • Modify SQL Model Structure API
      POST
    • Get Dataset Folder List API (Supports Search by Specified Folder)
      POST
    • Batch Query Dataset Basic Information
      POST
    • Clear Dataset Data
      GET
    • Batch Query Dataset Permission Information
      POST
  • Dashboards
    • Get Dashboard/Page List
    • Search Pages by Name Keyword
    • Get Users with Read Permission for Specified Page
    • Get Page List in Tree Structure
    • Export Dashboard as PDF or Image
    • Get Dashboard Export File
    • Get Page Basic Information
    • Get Page Information
    • Get Dashboard Smart Insights
  • Subscriptions and Alerts
    • Query Subscription List
    • Query Alert List
    • Download Custom Channel Push File
    • Enable/Disable Subscription
    • Enable/Disable Alert
  • Cards
    • Get Card Data
    • Create Card Based on Dataset API (Random ID Generation)
    • Get Card Insight Agent
  • Permissions
    • Get Pages Accessible by Specified User
    • Get Datasets Accessible by Specified User
    • Modify Page Access and Ownership for Specified User
    • Modify Dataset Access and Ownership for Specified User
    • Get Pages Accessible by Specified User Group
    • Get Datasets Accessible by Specified User Group
    • Modify Page Access and Ownership for Specified User Group
    • Modify Dataset Access and Ownership for Specified User Group
    • General Resource Permission Grant and Revoke
    • Grant Resource Permissions to Specified User or User Group
    • Revoke Resource Permissions from Specified User or User Group
  • Resource Operations
    • Migrate Resources with Owner Permission from Specified User to User Group or User
    • Migrate Resources with Owner Permission from Specified User Group to User Group or User
    • Generic Resource List
  • Card Exports
    • Card Export API Usage Instructions
    • Public API Card Export
    • Public API Task Status Polling
    • public-api Card Export File Download
  • Sessions
    • Create or Update Session
    • Query Dataset Session Configuration
  • Folders
    • Create Folder
    • Modify Folder Directory
    • Delete Folder API
    • Add Folder Permission API
    • Delete Folder Permission API
    • Batch Query Folder Permission Information
  • Data Accounts
    • Create Data Account
  • Authentication
    • User Login
    • Login via User loginId
    • User Logout
  • User Management
    • User Management Overview
    • User Groups
      • Batch Create User Groups
      • Batch Modify User Groups
      • Delete Specified User Group
      • Get User Group List
      • Add Single User Group
      • Delete User Group V2 API
    • User Group Members
      • Add Users to User Group
      • Remove User from User Group
      • Get Directly Mounted Users Under Specified User Group
      • Get Direct User Groups of Specified User
    • Roles
      • Query Role Information for Specified User
      • Add Custom Role for User
      • Unbind Custom Roles for User
    • User Linked Accounts
      • Linked Account Configuration Introduction
      • Configure User External Associated Account
      • Delete User Associated Account
      • Query User External Linked Accounts
  • System Related
    • Get Monitoring Information
  • Metric Center
    • Get Metric Data
    • Get Metric Project
    • Get Folders Under Metric Project
    • Get Metrics Under Specified Project and Folder
    • Get Metric Details
  • Lineage
    • Query Resource Lineage
    • Query Field Lineage
  • Insight Agent
    • Create Insight Agent Task
    • Query Conversation Details
  1. Developer Guide

Common Concepts

This document introduces concepts that may appear in multiple different modules. For concept explanations in specific modules, please refer to the documentation in the corresponding module directory.

domain#

BI is a multi-tenant system. Each tenant environment is called a domain, with the corresponding identifier parameter being domId (also domainId, domain). However, most private deployment environments have a single business domain, where only account and password are required for login without needing to fill in the domain. If you are unsure what the environment's domain is, you can query it through the document 《How to Get domainId Information》.

loginId#

The login account of a BI User. In most public APIs, loginId is used to specify the user; while in a few public APIs, the unique id of the BI User (uId) is used to specify the user.
Modified at 2026-07-15 06:40:52
Previous
Token Authentication
Next
Update Dataset Using Parquet File