观远数据开放平台
返回最新版
返回最新版
当前版本V7.1.0
  1. 仪表板
  • 开发指南
    • Token 鉴权
    • 常见概念
    • 常见问题
  • 数据集
    • 使用parquet文件更新数据集
      GET
    • 获取数据集列表
      POST
    • 修改数据集路径
      POST
    • 数据集删除
      POST
    • 搜索数据集列表
      POST
    • 查询特定数据集的数据结构
      POST
    • 批量修改数据集更新方式
      POST
    • 获取指定数据集有使用权限的用户列表
      POST
    • 上传数据集
      POST
    • 获取数据集下载授权Token
      GET
    • 下载数据集数据
      POST
    • 获取数据集数据
      POST
    • 创建数据集
      POST
    • 更新数据集字段注释
      POST
    • 触发数据集读取数据文件并更新
      GET
    • 通过 TaskID 查询数据集更新结果
      GET
    • 修改数据集schema
      POST
    • 更新数据集
      POST
    • 修改数据集字段别名
      POST
    • 修改数据集名称
      POST
    • 数据集预览接口
      POST
    • 提供修改SQL模型结构接口
      POST
    • 获取数据集目录列表的接口,支持指定目录搜索
      POST
    • 批量查询数据集基本信息
      POST
    • 批量查询数据集权限信息
      POST
  • 仪表板
    • 获取页面列表
      POST
    • 根据页面名称关键词搜索页面
      POST
    • 获取指定页面有读权限的用户列表
      POST
    • 以树状结构获取页面列表
      POST
    • 以PDF或者图片模式导出仪表板
      POST
    • 获取仪表板导出文件
      POST
    • 获取页面基本信息
      GET
    • 获取页面信息
      GET
  • 订阅预警
    • 下载自定义渠道推送文件
    • 启用/关闭订阅
    • 启用/关闭预警
  • 卡片
    • 获取卡片数据
    • 基于数据集创建卡片接口,提供生成随机ID的接口
  • 权限
    • 获取指定用户能访问的页面列表
    • 获取指定用户能访问的数据集列表
    • 修改指定用户与各个页面的访问及归属关系
    • 修改指定用户与各个数据集的访问及归属关系
    • 获取指定用户组能访问的页面列表
    • 获取指定用户组能访问的数据集列表
    • 修改指定用户组与各个页面的访问及归属关系
    • 修改指定用户组与各个数据集的访问及归属关系
    • 通用资源权限授权与解除
  • 资源操作
    • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
    • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
    • 通用资源列表清单
  • 卡片导出
    • 卡片导出接口使用说明
    • public api 卡片导出
    • public api 任务状态轮询
    • public-api 卡片导出文件下载
  • session
    • session创建or更新
    • 查询数据集的session配置
  • 文件夹
    • 创建文件夹目录
    • 修改文件夹目录
    • 删除文件夹接口
    • 文件夹新增授权接口
    • 文件夹删除权限接口
    • 批量查询文件夹权限信息
  • 数据账户
    • 创建数据账户
  • 身份认证
    • 用户登录
    • 通过用户的loginId登录
    • 用户登出
  • 用户管理
    • 用户管理概述
    • 用户
      • 批量创建用户
      • 批量删除用户
      • 批量修改用户属性
      • 批量获取用户是否存在
      • 通过属性值获取用户列表
      • 获取用户列表
      • 通过loginId获取用户信息
      • 修改用户状态
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
      • 添加单个用户组
    • 用户组成员
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 用户关联账号
      • 关联账号配置介绍
      • 配置用户外部关联账号
      • 删除用户的关联账号
      • 查询用户的外部关联账号
  1. 仪表板

获取页面信息

GET
/public-api/page/{pgId}
接口简介
通过指定页面id,获取页面信息,BI V7.1及以上版本支持该接口

请求参数

Path 参数

Header 参数

请求示例代码

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

返回响应

🟢200成功
application/json
Body

示例
{
    "result": "ok",
    "response": {
        "pgId": "f88ecade37f234d7aa0f7fb6",
        "domId": "guanbi",
        "name": "人力指数",
        "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": "迷你图值不展示",
                "description": "描述信息",
                "dsId": "r6962c818892942b4aefb588",
                "ctime": "2024-04-16 19:09:46+0800",
                "utime": "2024-12-13 18:04:26+0800"
            }
        ],
        "dsInfos": [
            {
                "dsId": "r6962c818892942b4aefb588",
                "name": "人力指数",
                "columns": [
                    {
                        "name": "编号ID",
                        "fdType": "LONG",
                        "fdId": "bdf5fe24dc90748a493e240e"
                    },
                    {
                        "name": "配送数",
                        "fdType": "LONG",
                        "fdId": "ecdde89b277df4dafb2cfc17"
                    },
                    {
                        "name": "省份",
                        "fdType": "STRING",
                        "fdId": "h0fc56cec830744628aec864"
                    },
                    {
                        "name": "日期",
                        "fdType": "DATE",
                        "fdId": "i8d1efb1411f84c1c86e1ec4"
                    },
                    {
                        "name": "产地",
                        "fdType": "STRING",
                        "fdId": "ic37729f3ff3b43af81dadae"
                    },
                    {
                        "name": "区县",
                        "fdType": "STRING",
                        "fdId": "if81dd884f7b04ee28c404f7"
                    },
                    {
                        "name": "人力指数",
                        "fdType": "DECIMAL",
                        "fdId": "j02e2a3adde474e3b8ff0edc"
                    },
                    {
                        "name": "单位",
                        "fdType": "STRING",
                        "fdId": "keebfa984ea0d4d0b9375043"
                    },
                    {
                        "name": "商品分类",
                        "fdType": "STRING",
                        "fdId": "l739f8e4a15a142aa82cd3a1"
                    },
                    {
                        "name": "商品编号",
                        "fdType": "LONG",
                        "fdId": "m1760bb6da1934996a27953e"
                    },
                    {
                        "name": "订购数量",
                        "fdType": "LONG",
                        "fdId": "mda3f6b92d9f845a98e5a9c3"
                    },
                    {
                        "name": "商品条码",
                        "fdType": "LONG",
                        "fdId": "nae761f9c69e640208ead2a2"
                    },
                    {
                        "name": "城市代码",
                        "fdType": "LONG",
                        "fdId": "o3549de108c074289b8d6fc7"
                    },
                    {
                        "name": "规格",
                        "fdType": "STRING",
                        "fdId": "o9154773a20d645a2a3cec8f"
                    },
                    {
                        "name": "城市",
                        "fdType": "STRING",
                        "fdId": "paa209cddc5bd4a26adf07d0"
                    },
                    {
                        "name": "经度",
                        "fdType": "DOUBLE",
                        "fdId": "pcf1e408b67894e9ebe0ed38"
                    },
                    {
                        "name": "大区",
                        "fdType": "STRING",
                        "fdId": "pd086ee727d06429db1932c4"
                    },
                    {
                        "name": "纬度",
                        "fdType": "DOUBLE",
                        "fdId": "pf219822d2c914b7b85b58f1"
                    },
                    {
                        "name": "省份代码",
                        "fdType": "LONG",
                        "fdId": "r0bbb185e6a9641feafeffc4"
                    },
                    {
                        "name": "销售金额",
                        "fdType": "DOUBLE",
                        "fdId": "t077332f9022a48999256074"
                    },
                    {
                        "name": "销售数量",
                        "fdType": "LONG",
                        "fdId": "tfd36b44fb9ab4d0886d4d79"
                    },
                    {
                        "name": "库存状况",
                        "fdType": "STRING",
                        "fdId": "va7da3e99218347e1b5fd708"
                    },
                    {
                        "name": "商品名称",
                        "fdType": "STRING",
                        "fdId": "vfb72519ff0db48c6984cc70"
                    },
                    {
                        "name": "成本价",
                        "fdType": "DOUBLE",
                        "fdId": "x2269799b1ccb46568d34428"
                    },
                    {
                        "name": "零售价",
                        "fdType": "DOUBLE",
                        "fdId": "x6488e421b197423dbe6ff4e"
                    },
                    {
                        "name": "区县代码",
                        "fdType": "LONG",
                        "fdId": "xbdbf24cc0e7f4b578e121bb"
                    }
                ]
            }
        ]
    }
}
修改于 2025-04-29 08:33:58
上一页
获取页面基本信息
下一页
下载自定义渠道推送文件