统计图
获取单个图表详情
获取单个图表详情
鉴权方式
AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。
版本
请求地址
Path 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
worksheet_id | string | 是 | |
chart_id | string | 是 |
Header 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
HAP-Appkey | string | 是 | HAP应用密钥 |
HAP-Sign | string | 是 | HAP签名 |
响应参数
200Successful response| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 请求是否成功 |
data | object | 统计图详情 |
data.id | string | — |
data.chartId | string | 统计图唯一 ID |
data.chartName | string | 统计图名称 |
data.description | string | 统计图描述 |
data.chartType | string | 统计图类型，如 columnChart、barChart、lineChart、pieChart、pivotTable |
data.worksheetId | string | 关联工作表 ID |
data.viewId | string | 关联视图 ID |
data.dataScope | string | 数据权限范围：all 统计全部数据，permission 仅统计当前用户可见数据 |
data.timeFieldId | string | 时间筛选字段 ID |
data.timeRange | string | 时间范围，如 all、today、currentMonth、last30Days |
data.dimension | object[] | 维度字段列表，适用于非透视表图表类型 |
data.dimension.field | string | 维度字段 ID |
data.dimension.displayName | string | 显示名称覆盖 |
data.dimension.granularity | integer | 日期或地区字段的归组粒度 |
data.dimension.includeEmpty | boolean | 是否统计空值 |
data.values | object[] | 值字段列表 |
data.values.field | string | 指标字段 ID，计算记录数时为 rowid |
data.values.aggregation | string | 聚合方式，如 COUNT、DISTINCTCOUNT、SUM、MIN、MAX、AVG |
data.values.displayName | string | 显示名称覆盖 |
data.filter | object | 筛选器配置，根节点为 group |
data.filter.type | string | 筛选器节点类型 |
data.filter.logic | string | 条件组合方式 |
data.filter.children | object[] | 筛选子节点列表 |
curl -X GET "https://example.com/v3/app/worksheets/worksheet_id/charts/chart_id" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}"{ "success": true, "data": { "id": "chart_6a3cfcb09b7ac423962955cc", "chartId": "chart_6a3cfcb09b7ac423962955cc", "chartName": "异星生物数量分布", "description": "主要展示外星生物当前在基地的整体数量分布趋势", "chartType": "columnChart", "worksheetId": "6a3cfcb09b7ac4239629567e", "viewId": "view_6a3cfcb09b7ac423962955cb", "dataScope": "all", "timeFieldId": "ctime", "timeRange": "currentMonth", "dimension": [ { "field": "species_field_id", "displayName": "生物种类", "granularity": 0, "includeEmpty": false } ], "values": [ { "field": "rowid", "aggregation": "COUNT", "displayName": "记录数量" } ], "filter": { "type": "group", "logic": "AND", "children": [] } }}