观远数据开放平台
首页
官网
社区
文档
版本
当前版本V7.1.0
观远数据开放平台
  • 开发指南
  • 数据集
  • 仪表板
  • 订阅预警
  • 卡片
    • 获取卡片数据POST
    • 基于数据集创建卡片接口,提供生成随机ID的接口POST
  • 权限
  • 资源操作
  • 卡片导出
  • session
  • 文件夹
  • 数据账户
  • 身份认证
  • 用户管理
亮色模式

    获取卡片数据

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

    :::note[接口简介]
    通过指定卡片id,获取卡片数据信息
    :::

    图表类型说明
    字段:cd_type
    枚举值
    枚举名 存储值 注释
    CHART 0 图表
    TEXT 1 文本
    IFRAME 2 iframe
    DRILL 3 钻取
    PICTURE 4 图片
    PARAMETER 5 参数
    SELECTOR 6 筛选器
    LIST_VIEW 7 自定义列表
    TREE_SELECTOR 8 树状筛选器
    LAYOUT 9 布局
    CUSTOM 10 自定义
    ANALYSIS 11 增强分析
    MERGE_SELECTOR 12 自定义报表字段窗格
    图表类型
    数据库存储
    表:card
    字段:chart_type
    枚举值
    枚举名 存储值 注释
    BASIC_COLUMN 0 单柱图
    GROUPED_COLUMN 1 柱形簇状图
    STACKED_COLUMN 2 柱形堆积图
    PERCENT_STACKED_COLUMN 3 柱形百分比堆积图
    BASIC_BAR 4 单条图
    STACKED_BAR 5 条形堆积图
    PERCENT_STACKED_BAR 6 条形百分比堆积图
    BASIC_LINE 7 折线图
    PIE 8 饼图
    FOUR_QUADRANTS_SCATTER_PLOT 9 四象限散点图
    MULTI_LINE 10 多线图
    BASIC_SCATTER_PLOT 11 增强分析
    BASIC_MAP 12 中国行政地图
    BAIDU_HEAT_MAP 13 百度热力图
    PIVOT_TABLE 14 透视表
    SINGLE_VALUE 15 指标卡
    KPI_CARD 16 对比指标卡
    BULLET_BAR 17 子弹条形图
    BULLET_COLUMN 18 子弹柱形图
    SOLID_GAUGE 19 填充仪表板
    PROGRESS_BAR 20 进度图
    GROUPED_COLUMN_WITH_LINE 21 柱形簇 + 折线图
    STACKED_COLUMN_WITH_LINE 22 柱形堆积 + 折线图
    PERCENT_COLUMN_WITH_LINE 23 柱形百分比 + 折线图
    GROUPED_COLUMN_WITH_SYMBOL 24 柱形簇 + 符号图
    STACKED_COLUMN_WITH_SYMBOL 25 柱形堆积 + 符号图
    PERCENT_COLUMN_WITH_SYMBOL 26 柱形百分比 + 符号图
    SANKEY 27 桑基图
    BASIC_BUBBLE 28 气泡图
    BUBBLE_MAP 29 气泡行政图
    GROUPED_BAR 30 条形簇状图
    POINT_MAP 31 符号行政地图
    RADAR_LINE 32 雷达+折线图
    FUNNEL 33 漏斗图
    HORIZONTAL_FUNNEL 34 横向漏斗图
    BAIDU_MAP_WITH_SYMBOL 35 百度符号地图
    WATERFALL_COLUMN 36 柱形瀑布图
    PROGRESS_PIE 37 圆形进度图
    STACKED_SPLIT_COLUMN 38 柱形分组堆积图
    STACKED_SPLIT_BAR 39 条形分组堆积图
    LIQUID_GAUGE 40 流体进度图
    CALENDAR_VIEW 41 日历视图
    HEAT_MAP 42 热力图
    TREE_MAP 43 矩形树图
    CI_LINE 44 废弃
    PARETO 45 帕累托图
    SELECT 46 筛选器
    MULTI_SELECT 47 多选筛选器
    WORD_CLOUD 48 词云图
    TIME_SELECTOR 49 时间筛选器
    BOX_PLOT 50 箱线图
    TEXT_INTERVAL_SELECTOR 51 区间筛选器
    TIME_MACRO_SELECTOR 52 时间宏筛选器
    ACTIVITY_GAUGE 53 环形进度图
    YT_INDOOR_MAP 54 Etone室内地图
    FN_INDOOR_MAP 55 蜂鸟室内地图
    SURFACE_MAP 56 平面地图
    STACKED_AREA 57 面积堆积图
    PERCENT_STACKED_AREA 58 面积百分比堆积图
    RISING_SUN 59 旭日图
    LIST_VIEW 60 自定义列表
    WORLD_MAP 61 世界地图
    BAIDU_MIGRATION_MAP 62 百度迁徙图
    PLUGIN 63 可视化插件
    GROUPED_TABLE 64 分组表
    SCROLL_TABLE 65 轮播列表
    DETAIL_TABLE 66 明细表
    ITEM_VIEW 67 条目视图
    DATA_GRID 68 二维表
    MULTIDIMENSIONAL_SANKEY 69 多维桑基图
    BUTTERFLY 70 蝴蝶图
    DUMBBELL_PLOT 71 哑铃图
    KPI_TREND 72 指标趋势图

    请求参数

    Path 参数
    cardId
    string 
    卡片ID
    必需
    Header 参数
    X-Auth-Token
    string 
    个人Token
    必需
    Body 参数application/json
    dynamicParams
    array [object] 
    动态参数列表
    必需
    offset
    integer 
    数据的起始位置
    可选
    limit
    integer 
    获取的数据条数
    可选
    view
    enum<string> 
    数据获取方式
    必需
    枚举值:
    GRAPHGRID
    示例
    {
      "dynamicParams": [
        {}
      ],
      "offset": 0,
      "limit": 0,
      "view": "GRAPH"
    }

    示例代码

    返回响应

    成功(200)
    HTTP 状态码: 200
    内容格式: JSONapplication/json
    数据结构
    result
    string 
    请求状态
    必需

    枚举值: ok、fail

    response
    object 
    响应结果
    必需
    chartMain
    object 
    可选

    不同的图表返回参数不一样, 具体图表可以找对应研发了解.

    view
    string 
    必需

    视图类型 GRID/GRAPH

    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"
      }
    }
    最后修改时间: 2 个月前
    下一页
    POST基于数据集创建卡片接口,提供生成随机ID的接口
    举报