获取卡片数据

8.4.0 入参、出参补充说明

本接口按目标图表卡片配置取数，并校验当前用户的卡片读取权限。GRAPH 返回图形视图对应的数据结构；GRID 按数据表格视图组织结果。实际视图依次取请求 view、卡片 defaultView、GRAPH。

下方保留原有响应示例及结构。它展示的是一种表格/透视形态；不同图表的 chartMain 字段组织可能不同。示例中出现的 null 或整数样例不代表该字段在所有图表中只有这一种类型。

查询与分页

offset 从 0 开始。常见表格解析器未传时按 0 处理。

limit 是本次期望返回的条数，实际结果还受图表类型、卡片设置和租户查询限制影响，没有全接口统一的固定默认值。

chartMain.hasMoreData 表示本次分页之后是否仍有数据；chartMain.limitInfo.hasMoreData 表示查询结果是否超过查询行数上限，两者含义不同。

chartMain.count 是当前图表解析/查询范围下的行数，可能经过限制，不保证是底层数据集总行数。

筛选条件字段说明

字段	说明
`filters`	本次查询额外应用的字段过滤条件列表。每项通常使用 name、filterType、filterValue 描述字段、过滤方式和过滤值。服务端按 name 匹配卡片数据集字段的原名或别名，并填入对应字段 ID；多个条件共同参与查询。
`filters[].name`	筛选字段名称。服务端用该值匹配目标卡片数据集字段的原名或别名；名称应与卡片中实际字段保持一致。若有多个同名/同别名字段，代码取首个匹配字段。
`filters[].filterType`	过滤类型。常用值：GT 大于、GE 大于等于、LT 小于、LE 小于等于、BT 闭区间、EQ 等于、NE 不等于、IN 属于列表、NI 不属于列表；STARTSWITH/ENDSWITH/CONTAINS 分别表示以指定文本开头/结尾/包含，NOT_ 前缀表示取反；IS_NULL 为空，NOT_NULL 不为空。
`filters[].filterValue`	过滤值列表，元素使用字符串；数值和日期也按字符串传入。例如 GT 配 ["10"]，BT 配 ["10","20"] 表示大于等于 10 且小于等于 20，IN 配 ["华东","华南"] 表示匹配任一候选值。具体值格式须与字段类型及过滤类型一致。后端模型还允许数组元素为 null，用于支持空值的过滤类型。

数值示例：{"name":"销售额","filterType":"BT","filterValue":["10","20"]}。字段名与值须替换为目标卡片的实际字段和业务值。

动态参数字段说明

字段	是否必填	说明
`dpId`	是	动态参数 ID。使用目标卡片或数据集中已定义参数的真实 ID。
`name`	是	动态参数名称，与参数定义保持一致。
`valueType`	是	动态参数值类型。常用 NUMBER（数值）、DATE（日期）、STRING（字符串）；后端模型将此字段作为字符串读取，未在此处限定枚举。
`defaultValue`	否	本次查询使用的参数值。必须按字符串传入，例如数值参数传 "25"；此接口通过该字段读取传入值。
`fdId`	否	动态参数应用的字段 ID，可选。
`customize`	否	是否为自定义动态参数，可选。
`multiple`	否	是否为多值动态参数，可选。defaultValue 仍是字符串，应与已有参数配置约定保持一致。
`optionValue`	否	动态参数的可选值列表，可选。
`inheritParent`	否	是否继承父作用域参数，可选。
`paramType`	否	作用域参数类型：WORKFLOW 为工作流参数，DATADRIVEN 为数据驱动参数；可选。

参数值通过 defaultValue 传入，数值也使用字符串；不要另起 value 字段。省略 dynamicParams 时沿用卡片已有动态参数配置。

zoneFilter（自助取数查询配置）

zoneFilter 是自助取数专用查询参数，放在请求体顶层，为可选对象，也可传 null。它只作用于本次取数，不保存卡片配置。

参数结构

字段	类型	说明
zoneData	object	本次查询的行、列、指标、表头筛选和排序布局。
zoneData.row / column / metric	`array<object>`	字段条目包含key、name、metaType；实际按卡片字段key匹配。
zoneData.filters	`array<object>`	表头筛选：key、filterType、filterValue；还支持name、metaType、advFilter、advFilterContent、filterLevel、aggrType。
zoneData.sorting	`array<object>`	排序：key、ordering（asc/desc）；还支持name、metaType、customSort、isPinYinOrder。
detailMode	boolean	true按明细模式查询；省略或false走普通透视模式。
hasGrandTotalOnRow / hasGrandTotalOnColumn	boolean	普通透视模式的行/列区域总计开关。
grandTotal	object	onRow.position为TOP/BOTTOM；onColumn.position为LEFT/RIGHT，均使用字符串。
cellMerge	object	noMergeColumn、noMergeRow分别控制是否取消列/行单元格合并。
excludeConditionConfig	object	allResultsAreZero、resultsSumAreZero、allResultsAreNull和filterLevel（DETAIL/AGGREGATION/RESULT）。

详细子字段、类型和枚举见下方 Body 参数中的 zoneFilter 参数树。除字段条目实际需要key外，其他子字段按需传入；可选字段也接受null，数组中的字段条目应为对象。

使用时的关键区别

字段按key定位：key来自目标卡片的区域字段配置，不是数据集fdId，也不是字段名称；通常仅传key即可取原字段定义。筛选key须存在于调整后的行、列或指标中；排序key可从行、列、指标或已有排序字段中匹配。

传zoneData会重建展示区域：整个zoneData省略时保留原行/列/指标；一旦传入对象，缺少的row、column、metric会成为空区域。需要保留哪些字段，就显式提供完整列表；空数组表示清空。不要只传zoneData.filters而遗漏需要保留的区域。

排序的省略和空数组不同：zoneData.sorting省略时沿用原排序，传[]清空排序。customSort结构为 { "turnedOn": true, "sortOrder": ["华东", "华南"], "sortUnspecifiedValues": true }，turnedOn=true且sortOrder非空时才启用。

普通filters仍可使用：顶层filters按字段名或别名匹配；zoneData.filters是按key匹配的表头筛选，两者的结构和用途不同。filterValue为字符串列表，数值/日期也按字符串填写，必要时元素可为null。

排除条件需显式保留：普通透视模式下传入zoneFilter但省略excludeConditionConfig时，本次查询不沿用卡片原有排除配置；需要保留时把原配置显式传回。

示例一：保留原字段，按明细模式取数

{
  "view": "GRAPH",
  "zoneFilter": {
    "detailMode": true
  }
}

示例二：选择区域字段，筛选并排序

下列key是占位符，请替换为卡片的真实key。row/column/metric列表也应按卡片实际需要完整填写；示例中的空column表示清空列区域。

{
  "view": "GRAPH",
  "offset": 0,
  "limit": 100,
  "zoneFilter": {
    "detailMode": false,
    "zoneData": {
      "row": [
        {
          "key": "<ROW_FIELD_KEY>"
        }
      ],
      "column": [],
      "metric": [
        {
          "key": "<METRIC_FIELD_KEY>"
        }
      ],
      "filters": [
        {
          "key": "<ROW_FIELD_KEY>",
          "filterType": "IN",
          "filterValue": [
            "华东",
            "华南"
          ]
        }
      ],
      "sorting": [
        {
          "key": "<METRIC_FIELD_KEY>",
          "ordering": "desc"
        }
      ]
    }
  }
}

示例三：总计与合并设置

{
  "view": "GRAPH",
  "zoneFilter": {
    "detailMode": false,
    "hasGrandTotalOnRow": true,
    "hasGrandTotalOnColumn": true,
    "grandTotal": {
      "onRow": {
        "position": "BOTTOM"
      },
      "onColumn": {
        "position": "RIGHT"
      }
    },
    "cellMerge": {
      "noMergeColumn": true,
      "noMergeRow": true
    }
  }
}

返回数据的读取方式

表格/透视形态中，chartMain.data 为单元格矩阵，结合 row 与 column 的元信息和表头读取；单元格的 v 是原始值，显示格式由对应格式配置解释。

row、column 的表头、格式索引和字段标识用于解释结果布局；这些并非数据集字段清单的另一份副本。

chartMain.meta.axes 为卡片显示配置透传；没有在该后端接口中定义的单位、枚举和前端渲染细节不作额外约束。

接口简介

通过指定卡片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 指标趋势图

application/json

请求成功。response.chartMain 的具体结构随图表类型和实际视图变化；本页原有响应示例用于解释表格/透视形态，不能作为所有图表的固定结构。

Body

示例

{
    "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"
    }
}

查询与分页

筛选条件字段说明

动态参数字段说明

zoneFilter（自助取数查询配置）

参数结构

使用时的关键区别

示例一：保留原字段，按明细模式取数

示例二：选择区域字段，筛选并排序

示例三：总计与合并设置

返回数据的读取方式

请求参数

请求示例代码

返回响应

获取卡片数据

查询与分页#

筛选条件字段说明#

动态参数字段说明#

zoneFilter（自助取数查询配置）#

参数结构#

使用时的关键区别#

示例一：保留原字段，按明细模式取数#

示例二：选择区域字段，筛选并排序#

示例三：总计与合并设置#

返回数据的读取方式#

请求参数

请求示例代码

返回响应

查询与分页

筛选条件字段说明

动态参数字段说明

zoneFilter（自助取数查询配置）

参数结构

使用时的关键区别

示例一：保留原字段，按明细模式取数

示例二：选择区域字段，筛选并排序

示例三：总计与合并设置

返回数据的读取方式