观远数据开放平台
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文件更新数据集
      • 获取数据集列表
      • 搜索数据集列表
      • 查询特定数据集的数据结构
      • 批量修改数据集更新方式
      • 获取指定数据集有使用权限的用户列表
      • 上传数据
      • 获取数据集下载授权Token
      • 下载数据集数据
      • 获取数据集数据
      • 创建数据集
      • 更新数据集字段注释
      • 触发数据集读取数据文件并更新
      • 通过 TaskID 查询数据集更新结果
      • 修改数据集schema
      • 更新数据集
      • 修改数据集字段别名
    • 仪表板
      • 获取页面列表
      • 根据页面名称关键词搜索页面
      • 获取指定页面有读权限的用户列表
      • 以树状结构获取页面列表
      • 以PDF或者图片模式导出仪表板
      • 获取仪表板导出文件
    • 订阅预警
      • 下载自定义渠道推送文件
      • 启用/关闭订阅
      • 启用/关闭预警
    • 卡片
      • 获取卡片数据
        POST
    • 权限
      • 获取指定用户能访问的页面列表
      • 获取指定用户能访问的数据集列表
      • 修改指定用户与各个页面的访问及归属关系
      • 修改指定用户与各个数据集的访问及归属关系
      • 获取指定用户组能访问的页面列表
      • 获取指定用户组能访问的数据集列表
      • 修改指定用户组与各个页面的访问及归属关系
      • 修改指定用户组与各个数据集的访问及归属关系
      • 通用资源权限授权与解除
    • 资源操作
      • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
      • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
      • 通用资源列表清单
    • 用户登录
      POST
  1. 卡片

获取卡片数据

POST
/public-api/card/{cardId}/data

请求参数

Path 参数
cardId
string 
卡片ID
必需
Header 参数
X-Auth-Token
string 
个人Token
必需
Body 参数application/json
dynamicParams
array [object] 
可选
filters
array [object {3}] 
过滤条件列表
可选
name
string 
字段名
必需
filterType
enum<string> 
过滤类型
必需
枚举值:
GTGELTLEBTEQNEINNISTARTSWITHNOT_STARTSWITHENDSWITHNOT_ENDSWITHCONTAINSNOT_CONTAINSIS_NULLNOT_NULL
filterValue
array[string]
过滤值
必需
offset
integer 
数据的起始位置
可选
limit
integer 
获取的数据条数
可选
view
enum<string> 
数据获取方式
必需
枚举值:
GRAPHGRID
示例
{
    "dynamicParams": [
        {}
    ],
    "filters": [
        {
            "name": "string",
            "filterType": "GT",
            "filterValue": [
                "string"
            ]
        }
    ],
    "offset": 0,
    "limit": 0,
    "view": "GRAPH"
}

示例代码

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/card//data' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dynamicParams": [
        {}
    ],
    "filters": [
        {
            "name": "string",
            "filterType": "GT",
            "filterValue": [
                "string"
            ]
        }
    ],
    "offset": 0,
    "limit": 0,
    "view": "GRAPH"
}'

返回响应

🟢200成功
application/json
Body
result
string 
必需
response
object 
必需
chartMain
object 
可选
view
string 
必需
rawDataNotChanged
boolean 
可选
chartType
string 
必需
cardType
string 
必需
示例
{
    "result": "ok",
    "response": {
        "chartMain": {
            "offset": 0,
            "data": [
                [
                    {
                        "v": 700
                    }
                ],
                [
                    {
                        "v": 700
                    }
                ],
                [
                    {
                        "v": 700
                    }
                ],
                [
                    {
                        "v": 700
                    }
                ],
                [
                    {
                        "v": 739
                    }
                ],
                [
                    {
                        "v": 700
                    }
                ],
                [
                    {
                        "v": 700
                    }
                ],
                [
                    {
                        "v": 700
                    }
                ],
                [
                    {
                        "v": 700
                    }
                ],
                [
                    {
                        "v": 700
                    }
                ]
            ],
            "column": {
                "meta": [
                    {
                        "title": "度量",
                        "metaType": "METRIC",
                        "headerFormat": null,
                        "isMPH": true
                    }
                ],
                "values": [
                    [
                        {
                            "title": "单价",
                            "type": "metric",
                            "originTitle": "单价",
                            "alias": null,
                            "fmt_idx": 0,
                            "fdType": "LONG",
                            "fdId": "l99eda651f429419a900b156",
                            "headerFormat": null,
                            "key": "zCxQmiQVKI",
                            "miniChart": null,
                            "annotation": "",
                            "sortField": "c1",
                            "emptyCol": false
                        }
                    ]
                ],
                "fieldFormat": {
                    "dimThreshold": [],
                    "linkFormat": []
                },
                "metricFieldFormat": {
                    "numberFormat": [
                        null
                    ],
                    "conditionFormat": [
                        null
                    ],
                    "linkFormat": [
                        null
                    ]
                },
                "columnFieldFormat": {
                    "numberFormat": [
                        null
                    ]
                }
            },
            "count": 12,
            "meta": {
                "dynamicParameters": [],
                "axes": {
                    "categoryAxis": {
                        "showTitle": false,
                        "title": null,
                        "autoStep": true,
                        "step": "",
                        "distance": "",
                        "visible": true
                    },
                    "mainAxis": {
                        "tickInterval": null,
                        "max": "",
                        "unit": null,
                        "tickPosition": null,
                        "autoTickInterval": true,
                        "visible": true,
                        "min": "",
                        "distance": "",
                        "autoExtremes": true,
                        "showGridLine": true,
                        "title": null,
                        "showTitle": false,
                        "minorTickPosition": null
                    },
                    "navigator": {
                        "showNavigator": false,
                        "fixedValueAxis": true
                    }
                }
            },
            "hitCache": true,
            "extra": {
                "headerSortings": null
            },
            "limit": 10,
            "hasMoreData": true,
            "limitInfo": {
                "dataLimit": 20000,
                "colLimit": 100,
                "hasMoreData": false,
                "hasMoreCol": false
            },
            "row": {
                "fieldFormat": {
                    "dimThreshold": [
                        null
                    ],
                    "linkFormat": [
                        {
                            "type": "text"
                        }
                    ]
                },
                "rowFieldFormat": {
                    "numberFormat": [
                        null
                    ]
                },
                "meta": [
                    {
                        "fdId": "f070df980c55f4de2ad01b91",
                        "title": "店铺名称",
                        "originTitle": "店铺名称",
                        "alias": null,
                        "fdType": "STRING",
                        "metaType": "DIM",
                        "parentFdName": null,
                        "granularity": null,
                        "headerFormat": null,
                        "key": "UltHzhtQbN",
                        "annotation": "",
                        "sortField": "c0"
                    }
                ],
                "values": [
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "北京分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ],
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "云南分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ],
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "青海分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ],
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "江苏分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ],
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "山东分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ],
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "湖南分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ],
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "上海分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ],
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "广东分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ],
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "吉林分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ],
                    [
                        {
                            "titleType": "STRING",
                            "granularity": null,
                            "title": "浙江分店",
                            "num_fmt_idx": 0,
                            "emptyCol": false
                        }
                    ]
                ]
            },
            "config": null
        },
        "view": "GRID",
        "rawDataNotChanged": false,
        "chartType": "BASIC_COLUMN",
        "cardType": "CHART"
    }
}
修改于 2025-09-10 07:32:00
上一页
启用/关闭预警
下一页
获取指定用户能访问的页面列表