观远数据开放平台
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
首页官网社区
文档
  • 帮助中心
  • 观远学堂
首页官网社区
文档
  • 帮助中心
  • 观远学堂
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
  1. 数据集
  • 默认模块
    • 开发指南
      • Token 鉴权
      • 常见问题
    • 用户
      • 批量创建用户
      • 批量删除用户
      • 批量修改用户属性
      • 批量查询用户是否存在
      • 获取用户列表
      • 修改指定用户状态
      • 通过指定的用户的loginid查询对应的uid
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
      • 用户统一登出
      • 通过用户属性值查询用户列表
      • 通过指定用户的loginid登录
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 数据集
      • 使用parquet文件更新数据集
        GET
      • 获取数据集列表
        POST
      • 搜索数据集列表
        POST
      • 查询特定数据集的数据结构
        POST
      • 批量修改数据集更新方式
        POST
      • 获取指定数据集有使用权限的用户列表
        POST
      • 上传数据
        POST
      • 获取数据集下载授权Token
        GET
      • 下载数据集数据
        POST
      • 获取数据集数据
        POST
      • 创建数据集
        POST
      • 更新数据集字段注释
        POST
      • 触发数据集读取数据文件并更新
        GET
      • 通过 TaskID 查询数据集更新结果
        GET
      • 修改数据集schema
        POST
      • 更新数据集
        POST
      • 修改数据集字段别名
        POST
    • 仪表板
      • 获取页面列表
      • 根据页面名称关键词搜索页面
      • 获取指定页面有读权限的用户列表
      • 以树状结构获取页面列表
      • 以PDF或者图片模式导出仪表板
      • 获取仪表板导出文件
    • 订阅预警
      • 下载自定义渠道推送文件
      • 启用/关闭订阅
      • 启用/关闭预警
    • 卡片
      • 获取卡片数据
    • 权限
      • 获取指定用户能访问的页面列表
      • 获取指定用户能访问的数据集列表
      • 修改指定用户与各个页面的访问及归属关系
      • 修改指定用户与各个数据集的访问及归属关系
      • 获取指定用户组能访问的页面列表
      • 获取指定用户组能访问的数据集列表
      • 修改指定用户组与各个页面的访问及归属关系
      • 修改指定用户组与各个数据集的访问及归属关系
      • 通用资源权限授权与解除
    • 资源操作
      • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
      • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
      • 通用资源列表清单
    • 用户登录
      POST
  1. 数据集

下载数据集数据

POST
/public-api/data-source/{dsId}/token/{token}
该api一次最多返回5万行数据,若数据集较大,请指定过滤条件。
如果cols和filters都没有指定,则请求返回数据集所有列和行。注意,即使两个参数都没有指定,请求体也不能省略,即{}。

请求参数

Path 参数
dsId
string 
数据集ID
必需
token
string 
必需
授权token。用于数据获取的token,即为/api/data-source/{dsId}/data-fetch-token接口返回的dataFetchToken
Body 参数application/json
cols
array[string]
获取指定字段
可选
默认获取所有字段
filters
array [object {3}] 
过滤条件列表
可选
name
string 
字段名
必需
filterType
enum<string> 
过滤类型
必需
枚举值:
GTGELTLEBTEQNEINNISTARTSWITHNOT_STARTSWITHENDSWITHNOT_ENDSWITHCONTAINSNOT_CONTAINSIS_NULLNOT_NULL
filterValue
array[string]
过滤值
必需
示例
{
    "cols": [
        "string"
    ],
    "filters": [
        {
            "name": "string",
            "filterType": "GT",
            "filterValue": [
                "string"
            ]
        }
    ]
}

示例代码

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/data-source//token/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cols": [
        "string"
    ],
    "filters": [
        {
            "name": "string",
            "filterType": "GT",
            "filterValue": [
                "string"
            ]
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
result
string 
必需
response
object 
必需
columns
array[string]
必需
total
integer 
必需
count
integer 
必需
data
array [array] 
必需
示例
{
    "result": "ok",
    "response": {
        "columns": [
            "省",
            "性别",
            "订单数",
            "客单价"
        ],
        "total": 2,
        "count": 2,
        "data": [
            [
                "上海",
                "男",
                "5",
                "7"
            ],
            [
                "上海",
                "女",
                "6",
                "8"
            ]
        ]
    }
}
修改于 2025-07-16 03:18:58
上一页
获取数据集下载授权Token
下一页
获取数据集数据