观远数据开放平台
7.2.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
首页官网社区
文档
  • 帮助中心
  • 观远学堂
首页官网社区
文档
  • 帮助中心
  • 观远学堂
7.2.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
  1. 仪表板
  • 开发指南
    • Token 鉴权
    • 常见概念
    • 常见问题
  • 用户
    • 批量创建用户
      POST
    • 批量修改用户属性
      POST
    • 批量删除用户
      POST
    • 批量获取用户是否存在
      POST
    • 获取用户列表
      POST
    • 通过属性值获取用户列表
      POST
    • 修改用户状态
      POST
    • 通过loginId获取用户信息
      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
    • 数据集预览接口
      POST
    • 提供修改SQL模型结构接口
      POST
    • 获取数据集目录列表的接口,支持指定目录搜索
      POST
    • 批量查询数据集基本信息
      POST
    • 批量查询数据集权限信息
      POST
  • 仪表板
    • 获取页面列表
      POST
    • 根据页面名称关键词搜索页面
      POST
    • 获取指定页面有读权限的用户列表
      POST
    • 以树状结构获取页面列表
      POST
    • 以PDF或者图片模式导出仪表板
      POST
    • 获取仪表板导出文件
      POST
    • 获取页面基本信息
      GET
    • 获取页面信息
      GET
    • 仪表板智能洞察
      POST
  • 订阅预警
    • 下载自定义渠道推送文件
    • 启用/关闭订阅
    • 启用/关闭预警
  • 卡片
    • 获取卡片数据
    • 基于数据集创建卡片接口,提供生成随机ID的接口
  • 权限
    • 获取指定用户能访问的页面列表
    • 获取指定用户能访问的数据集列表
    • 修改指定用户与各个页面的访问及归属关系
    • 修改指定用户与各个数据集的访问及归属关系
    • 获取指定用户组能访问的页面列表
    • 获取指定用户组能访问的数据集列表
    • 修改指定用户组与各个页面的访问及归属关系
    • 修改指定用户组与各个数据集的访问及归属关系
    • 通用资源权限授权与解除
  • 资源操作
    • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
    • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
    • 通用资源列表清单
  • 卡片导出
    • 卡片导出接口使用说明
    • public api 卡片导出
    • public api 任务状态轮询
    • public-api 卡片导出文件下载
  • session
    • session创建or更新
    • 查询数据集的session配置
  • 文件夹
    • 创建文件夹目录
    • 修改文件夹目录
    • 删除文件夹接口
    • 文件夹新增授权接口
    • 文件夹删除权限接口
    • 批量查询文件夹权限信息
  • 数据账户
    • 创建数据账户
  • 身份认证
    • 用户登录
    • 通过用户的loginId登录
    • 用户登出
  • 用户管理
    • 用户管理概述
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
      • 添加单个用户组
    • 用户组成员
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 用户关联账号
      • 关联账号配置介绍
      • 配置用户外部关联账号
      • 删除用户的关联账号
      • 查询用户的外部关联账号
  1. 仪表板

仪表板智能洞察

POST
/public-api/page/{pgId}/intelligent-insight
接口简介
如果指定了具体的用户信息,将以特定的用户名义(数据权限)获取仪表板智能洞察。
特别说明:
① 该接口为限时免费API接口。 不排除未来额外收费可能。

请求参数

Path 参数
pgId
string 
必需
Body 参数application/json
token
string 
应用token
必需
开放平台设置中的账号同步令牌 (Token)
loginId
string 
登录账号
可选
如a@b.com; 如果uId也填写了,优先使用loginId
uId
string 
用户id
可选
系统中的ID,为一个字符串。如果LoginID与uId都不填写,则以管理员名义
locale
string 
语言偏好
可选
默认值zh-CN
selectorValues
array [object {2}] 
筛选条件
可选
selectorId
string 
筛选器id
可选
defaultValue
array[string]
筛选值
可选
prompt
object 
可选
requirements
string 
输出要求
可选
analysis
string 
洞察思路
可选
knowledge
string 
业务知识
可选
stream
boolean 
是否流式传输
可选
默认为true
temperature
number 
默认0
可选
示例
{
    "token": "string",
    "loginId": "string",
    "uId": "string",
    "locale": "string",
    "selectorValues": [
        {
            "selectorId": "string",
            "defaultValue": [
                "string"
            ]
        }
    ],
    "prompt": {
        "requirements": "string",
        "analysis": "string",
        "knowledge": "string"
    },
    "stream": true,
    "temperature": 0
}

示例代码

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/page//intelligent-insight' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string",
    "loginId": "string",
    "uId": "string",
    "locale": "string",
    "selectorValues": [
        {
            "selectorId": "string",
            "defaultValue": [
                "string"
            ]
        }
    ],
    "prompt": {
        "requirements": "string",
        "analysis": "string",
        "knowledge": "string"
    },
    "stream": true,
    "temperature": 0
}'

返回响应

🟢200成功
text/event-stream
默认为流式响应,响应的内容和在bi中配置的大模型的响应相同
Body
object {0}
🟢200成功
修改于 2025-10-31 01:28:23
上一页
获取页面信息
下一页
下载自定义渠道推送文件