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. Dashboards
  • 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
      POST
    • Search Pages by Name Keyword
      POST
    • Get Users with Read Permission for Specified Page
      POST
    • Get Page List in Tree Structure
      POST
    • Export Dashboard as PDF or Image
      POST
    • Get Dashboard Export File
      POST
    • Get Page Basic Information
      GET
    • Get Page Information
      GET
    • Get Dashboard Smart Insights
      POST
  • 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. Dashboards

Get Page Information

GET
/public-api/page/{pgId}
API Description
Get page information by specifying page ID; supported in BI V7.1 and above

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/public-api/page/bbb8ee5556b1c4ad2bf7f61e' \
--header 'token: s5de3b9fa689140419b0b73f'

Responses

🟢200Success
application/json
Body

Examples
{
    "result": "ok",
    "response": {
        "pgId": "f88ecade37f234d7aa0f7fb6",
        "domId": "guanbi",
        "name": "Labor Index",
        "pgType": "PAGE",
        "description": "",
        "parentDirId": "o8e47ca4c959a4fbc93c27f3",
        "ctime": "2024-04-16 19:09:41+0800",
        "utime": "2024-04-16 19:10:30+0800",
        "cards": [
            {
                "cdType": "CHART",
                "cdId": "w54625bffb1c84a9885101fd",
                "name": "Sparkline values hidden",
                "description": "Description info",
                "dsId": "r6962c818892942b4aefb588",
                "ctime": "2024-04-16 19:09:46+0800",
                "utime": "2024-12-13 18:04:26+0800"
            }
        ],
        "dsInfos": [
            {
                "dsId": "r6962c818892942b4aefb588",
                "name": "Labor Index",
                "columns": [
                    {
                        "name": "ID",
                        "fdType": "LONG",
                        "fdId": "bdf5fe24dc90748a493e240e"
                    },
                    {
                        "name": "Delivery Count",
                        "fdType": "LONG",
                        "fdId": "ecdde89b277df4dafb2cfc17"
                    },
                    {
                        "name": "Province",
                        "fdType": "STRING",
                        "fdId": "h0fc56cec830744628aec864"
                    },
                    {
                        "name": "Date",
                        "fdType": "DATE",
                        "fdId": "i8d1efb1411f84c1c86e1ec4"
                    },
                    {
                        "name": "Origin",
                        "fdType": "STRING",
                        "fdId": "ic37729f3ff3b43af81dadae"
                    },
                    {
                        "name": "District",
                        "fdType": "STRING",
                        "fdId": "if81dd884f7b04ee28c404f7"
                    },
                    {
                        "name": "Labor Index",
                        "fdType": "DECIMAL",
                        "fdId": "j02e2a3adde474e3b8ff0edc"
                    },
                    {
                        "name": "Unit",
                        "fdType": "STRING",
                        "fdId": "keebfa984ea0d4d0b9375043"
                    },
                    {
                        "name": "Product Category",
                        "fdType": "STRING",
                        "fdId": "l739f8e4a15a142aa82cd3a1"
                    },
                    {
                        "name": "Product Code",
                        "fdType": "LONG",
                        "fdId": "m1760bb6da1934996a27953e"
                    },
                    {
                        "name": "Order Qty",
                        "fdType": "LONG",
                        "fdId": "mda3f6b92d9f845a98e5a9c3"
                    },
                    {
                        "name": "Barcode",
                        "fdType": "LONG",
                        "fdId": "nae761f9c69e640208ead2a2"
                    },
                    {
                        "name": "City Code",
                        "fdType": "LONG",
                        "fdId": "o3549de108c074289b8d6fc7"
                    },
                    {
                        "name": "Spec",
                        "fdType": "STRING",
                        "fdId": "o9154773a20d645a2a3cec8f"
                    },
                    {
                        "name": "City",
                        "fdType": "STRING",
                        "fdId": "paa209cddc5bd4a26adf07d0"
                    },
                    {
                        "name": "Longitude",
                        "fdType": "DOUBLE",
                        "fdId": "pcf1e408b67894e9ebe0ed38"
                    },
                    {
                        "name": "Region",
                        "fdType": "STRING",
                        "fdId": "pd086ee727d06429db1932c4"
                    },
                    {
                        "name": "Latitude",
                        "fdType": "DOUBLE",
                        "fdId": "pf219822d2c914b7b85b58f1"
                    },
                    {
                        "name": "Province Code",
                        "fdType": "LONG",
                        "fdId": "r0bbb185e6a9641feafeffc4"
                    },
                    {
                        "name": "Sales Amount",
                        "fdType": "DOUBLE",
                        "fdId": "t077332f9022a48999256074"
                    },
                    {
                        "name": "Sales Qty",
                        "fdType": "LONG",
                        "fdId": "tfd36b44fb9ab4d0886d4d79"
                    },
                    {
                        "name": "Stock Status",
                        "fdType": "STRING",
                        "fdId": "va7da3e99218347e1b5fd708"
                    },
                    {
                        "name": "Product Name",
                        "fdType": "STRING",
                        "fdId": "vfb72519ff0db48c6984cc70"
                    },
                    {
                        "name": "Cost Price",
                        "fdType": "DOUBLE",
                        "fdId": "x2269799b1ccb46568d34428"
                    },
                    {
                        "name": "Retail Price",
                        "fdType": "DOUBLE",
                        "fdId": "x6488e421b197423dbe6ff4e"
                    },
                    {
                        "name": "District Code",
                        "fdType": "LONG",
                        "fdId": "xbdbf24cc0e7f4b578e121bb"
                    }
                ]
            }
        ]
    }
}
Modified at 2026-07-15 06:42:05
Previous
Get Page Basic Information
Next
Get Dashboard Smart Insights