观远数据开放平台
8.4.0
  • 8.4.0
  • 8.3.0
  • 8.2.0
  • 8.1.0
  • 7.4.0
  • 7.3.0
首页官网社区英文版
文档
  • 帮助中心
  • 观远学堂
首页官网社区英文版
文档
  • 帮助中心
  • 观远学堂
8.4.0
  • 8.4.0
  • 8.3.0
  • 8.2.0
  • 8.1.0
  • 7.4.0
  • 7.3.0
  1. 数据集
  • 用户
    • 批量创建用户
      POST
    • 批量删除用户
      POST
    • 批量修改用户属性
      POST
    • 批量获取用户是否存在
      POST
    • 通过属性值获取用户列表
      POST
    • 获取用户列表
      POST
    • 通过loginId获取用户信息
      POST
    • 修改用户状态
      POST
  • 开发指南
    • Token 鉴权
    • 常见概念
  • 数据集
    • 清空数据集数据
      GET
    • 获取数据集数据_V2
      POST
    • 数据集删除_V2
      POST
    • 使用parquet文件更新数据集
      GET
    • 获取数据集列表
      POST
    • 修改数据集路径
      POST
    • 数据集删除
      POST
    • 搜索数据集列表
      POST
    • 查询特定数据集的数据结构
      POST
    • 批量修改数据集更新方式
      POST
    • 获取指定数据集有使用权限的用户列表
      POST
    • 上传数据集
      POST
    • 获取数据集下载授权Token
      GET
    • 下载数据集数据
      POST
    • 获取数据集数据
      POST
    • 创建数据集
      POST
    • 更新数据集字段注释
      POST
    • 触发数据集读取数据文件并更新
      GET
    • 通过 TaskID 查询数据集更新结果
      GET
    • 修改数据集schema
      POST
    • 更新数据集
      POST
    • 修改数据集字段别名
      POST
    • 修改数据集名称
      POST
    • 提供修改SQL模型结构接口
      POST
    • 获取数据集目录列表的接口,支持指定目录搜索
      POST
    • 批量查询数据集基本信息
      POST
    • 批量查询数据集权限信息
      POST
  • 仪表板
    • 获取页面列表
    • 根据页面名称关键词搜索页面
    • 获取指定页面有读权限的用户列表
    • 以树状结构获取页面列表
    • 以PDF或者图片模式导出仪表板
    • 获取仪表板导出文件
    • 获取页面基本信息
    • 获取页面信息
    • 获取仪表板智能洞察
    • 删除仪表板
  • 卡片
    • 获取卡片数据
    • 基于数据集创建卡片接口,提供生成随机ID的接口
    • 获取卡片智能洞察
    • 获取卡片数据_V2
  • 订阅预警
    • 查询订阅列表
    • 查询预警列表
    • 通知发送历史查询记录
    • 下载自定义渠道推送文件
    • 启用/关闭订阅
    • 启用/关闭预警
  • 权限
    • 获取指定用户能访问的页面列表
    • 获取指定用户能访问的数据集列表
    • 修改指定用户与各个页面的访问及归属关系
    • 修改指定用户与各个数据集的访问及归属关系
    • 获取指定用户组能访问的页面列表
    • 获取指定用户组能访问的数据集列表
    • 修改指定用户组与各个页面的访问及归属关系
    • 修改指定用户组与各个数据集的访问及归属关系
    • 通用资源权限授权与解除
    • 对指定用户或用户组进行资源授权
    • 取消指定用户或用户组的资源授权
  • 资源操作
    • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
    • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
    • 通用资源列表清单
  • 卡片导出
    • 卡片导出接口使用说明
    • public api 卡片导出
    • public api 任务状态轮询
    • public-api 卡片导出文件下载
  • session
    • session创建or更新
    • 查询数据集的session配置
  • 文件夹
    • 创建文件夹目录
    • 修改文件夹目录
    • 删除文件夹接口
    • 文件夹新增授权接口
    • 文件夹删除权限接口
    • 批量查询文件夹权限信息
  • 数据账户
    • 创建数据账户
  • 身份认证
    • 用户登录
    • 通过用户的loginId登录
    • 用户登出
  • 用户管理
    • 用户管理概述
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
      • 添加单个用户组
      • 删除用户组V2接口
    • 用户组成员
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 用户关联账号
      • 关联账号配置介绍
      • 配置用户外部关联账号
      • 删除用户的关联账号
      • 查询用户的外部关联账号
  • 系统相关
    • 获取监控信息
  • 指标中心
    • 获取指标主题
    • 获取指标主题下的文件夹列表
    • 获取指定主题和文件夹下的指标列表
    • 获取指标详情
    • 获取指标数据
  • 血缘
    • 查询资源血缘
    • 查询字段血缘
  • 洞察agent
    • 创建洞察Agent任务
    • 查询对话详情
  1. 数据集

获取数据集数据_V2

开发中
POST
/public-api/v2/data-source/{dataSourceId}/data
查询指定数据集的数据,返回字段信息和数据行。按 X-Public-User-Id 指定的用户执行,用户须有数据集模块及目标数据集的读取权限。查询遵循行列权限和脱敏规则。

鉴权#

通过 X-Public-User-Id 传入凭证所属租户中已启用用户的登录账号(loginId)。
鉴权二选一:
Authorization: Bearer <access_token>,OAuth2 应用须获得 legacy-public-api:full-access scope。
X-Public-Token: <集成Token>,使用统一账户集成 Token,租户须启用统一账户集成。
示例中的 BI_BASE_URL 为 BI 服务的 API 地址前缀,例如 https://bi.example.com/backend,请按部署环境填写。

请求示例#

示例按 id 升序查询前两行。请将示例数据集 ID 和字段名换成实际值。
必须发送 JSON 对象作为请求体。顶层字段均可省略,使用默认值时发送 {}。offset 默认 0,limit 默认 50000,超过 50000 时按 50000 处理。

响应#

成功时 result 为 ok。response.columns 描述返回列,response.preview 是二维数组,每一项代表一行,单元格按列顺序排列。数值和日期以字符串返回,缺失值为 null。下方响应示例只展示主要字段。业务处理失败时,检查 result 和 error;鉴权失败也可能通过 HTTP 错误状态返回。

请求参数

Path 参数

Header 参数

Body 参数application/json

示例
{
    "cols": [
        "id",
        "region",
        "amount"
    ],
    "offset": 0,
    "limit": 2,
    "sortFactor": {
        "name": "id",
        "sortType": "asc"
    }
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/public-api/v2/data-source/d0123456789abcdef0123456/data' \
--header 'X-Public-User-Id: analyst@example.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cols": [
        "id",
        "region",
        "amount"
    ],
    "offset": 0,
    "limit": 2,
    "sortFactor": {
        "name": "id",
        "sortType": "asc"
    }
}'

返回响应

🟢200成功
application/json
业务响应。请检查 result。
Body

示例
{
    "result": "ok",
    "response": {
        "dsId": "d0123456789abcdef0123456",
        "columns": [
            {
                "name": "id",
                "fdType": "INT"
            },
            {
                "name": "region",
                "fdType": "STRING"
            },
            {
                "name": "amount",
                "fdType": "DOUBLE"
            }
        ],
        "colCount": 3,
        "preview": [
            [
                "1",
                "华东",
                "9"
            ],
            [
                "2",
                "华东",
                "18"
            ]
        ],
        "hitCache": false
    }
}
🟠400请求有误
🟠401没有权限
🟠403禁止访问
🟠429429
修改于 2026-11-05 07:39:59
上一页
清空数据集数据
下一页
数据集删除_V2