概述
获取用户信息和用户创建的仪表板
接口简介
| 接口作用 | 获取用户信息和用户创建的仪表板 |
| 接口URL | /v5/api/dashboard/user/info |
| 请求类型 | GET |
响应实例
| 请求示例 | http://192.168.101.92:8883/webroot/decision/v5/api/dashboard/user/info 注：使用接口时需要登录，需要传递token参数。
|
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "userInfo": { "displayName": "admin(admin)", "postNames": [], "departmentNames": [], "customRoleNames": [ "superusers" ], "departmentPosts": [] }, "dashboards": [ { "reportId": "1474e86a9fa846b68766da93a82bb5c8", "name": "淘宝店铺流量分析", "initTime": 1660802724185, "lastUpdateTime": 0, "createBy": "621beb84-59b7-412c-b2f3-78a7b7aeab1a", "watermark": true }, { "reportId": "f2956a466b6c47f29502ccc0534869f5", "name": "图表实用场景", "initTime": 1660808551876, "lastUpdateTime": 0, "createBy": "621beb84-59b7-412c-b2f3-78a7b7aeab1a", "watermark": true } ] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 |  |
发布管理节点所有仪表板信息
接口简介
| 接口作用 | 获取发布管理节点下的仪表板信息 |
| 接口URL | /v5/api/dashboard/search |
| 请求类型 | GET |
| 注意事项 | 使用该接口的用户，必须有发布管理节点权限 |
请求参数-Query参数
| 参数名 | 参数值 | 是否必填 |
|---|---|---|
| page | 发布管理的页面页码 | 是 |
| count | 每页信息数量 | 是 |
响应实例
| 请求示例 | http://192.168.101.92:8883/webroot/decision/v5/api/dashboard/search?page=2&count=1 注：使用接口时需要登录，需要传递token参数。
|
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "reportIndexList": [ { "userInfo": { "displayName": "admin(admin)", "postNames": [], "departmentNames": [], "customRoleNames": [ "superusers" ], "departmentPosts": [] }, "reportIndex": { "reportId": "274aee6161f54f8eaf38ae3414917ab0", "name": "新手入门示例", "initTime": 1767592429688, "lastUpdateTime": 0, "createBy": "621beb84-59b7-412c-b2f3-78a7b7aeab1a", "watermark": true } } ], "applyingCount": 0, "totalCount": 73 }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | |
获取主题下的仪表板列表
接口简介
| 接口作用 | 获取某个主题下的仪表板列表 |
| 接口URL | /v5/api/platform/dashboard/list |
| 请求类型 | GET |
请求参数-Query参数
| 参数名 | 参数值 | 是否必填 |
|---|---|---|
| subjectId | 主题ID | 是 |
响应实例
| 请求示例 | http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/list?subjectId=5540f238907b472bbedd7595e0260614 注：使用接口时需要登录，需要传递token参数。
|
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "地产公司数据监控", "editable": true, "coopAnalysis": false, "creatorAuth": true, "tables": { "availableTables": [] }, "reports": { "availableReports": [ { "name": "地产公司销售监控", "initTime": 1533632466066, "lastUpdateTime": 0, "id": "6aae904df9284bef823921fac05fb247", "createBy": "admin", "shared": false, "publishStatus": 1, "editable": true, "publicLink": { "type": 0, "shared": false, "passProtected": false, "deadline": 0, "exportable": false }, "parentId": "5540f238907b472bbedd7595e0260614", "position": "我的分析/行业应用/地产建筑/地产公司数据监控", "coopAnalysis": false, "creatorAuth": true }, { "name": "集团CEO看板", "initTime": 1533289033311, "lastUpdateTime": 0, "id": "e9bf9ea3f0de40d08281ebc9753f4942", "createBy": "admin", "shared": false, "publishStatus": 1, "editable": true, "publicLink": { "type": 0, "shared": false, "passProtected": false, "deadline": 0, "exportable": false }, "parentId": "5540f238907b472bbedd7595e0260614", "position": "我的分析/行业应用/地产建筑/地产公司数据监控", "coopAnalysis": false, "creatorAuth": true } ] }, "docs": { "availableDocs": [] }, "widgets": { "availableWidgets": [] }, "biBusinessModels": { "availableModels": [] }, "customOrder": [], "tableCustomOrder": [], "customHide": [], "parentId": "bcf238bf6c354346863591f0039d7a88" }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | |
获取仪表板信息
接口简介
| 接口作用 | 获取仪表板的信息 |
| 接口URL | /v5/api/platform/dashboard/reports/info |
| 请求类型 | GET |
请求参数-Query参数
| 参数名 | 参数值 | 是否必填 | 描述说明 |
|---|---|---|---|
| info | {"index":[ { "id":"仪表板ID" }] }注：参数值格式为JSON，使用时需要进行编码 encodeURIComponent() | 是 | id：仪表板ID |
响应实例
| 请求示例 | 编码前参数值： {"index":[ { "id":"6aae904df9284bef823921fac05fb247" }] } 编码后参数值： %7B%22index%22%3A%5B%7B%22id%22%3A%226aae904df9284bef823921fac05fb247%22%7D%5D%7D 链接： http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/reports/info?info=%7B%22index%22%3A%5B%7B%22id%22%3A%226aae904df9284bef823921fac05fb247%22%7D%5D%7D 注：使用接口时需要登录，需要传递token参数。
|
| 响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "index": [ { "name": "地产公司销售监控", "initTime": 1533632466066, "lastUpdateTime": 0, "id": "6aae904df9284bef823921fac05fb247", "createBy": "admin", "shared": false, "publishStatus": 0, "editable": false, "publicLink": { "type": 0, "shared": false, "passProtected": false, "deadline": 0, "exportable": false }, "coopAnalysis": false, "creatorAuth": false } ] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截图示意 | |
获取仪表板中所有组件信息
接口简介
| 接口作用 | 获取仪表板中所有组件的信息 |
| 接口URL | /v5/api/dashboard/report/consanguinity |
| 请求类型 | GET |
请求参数-Query参数
| 参数名 | 参数值 | 是否必填 |
|---|---|---|
| reportId | 仪表板ID | 是 |
响应实例
| 请求示例 | http://192.168.101.92:8883/webroot/decision/v5/api/dashboard/report/consanguinity?reportId=6aae904df9284bef823921fac05fb247 注：使用接口时需要登录，需要传递token参数。
|
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": { "reportId": "6aae904df9284bef823921fac05fb247", "reportName": "地产公司销售监控", "widgets": [ { "widgetId": "ffcfdc7d9317448197cfadb1d3d1f227", "widgetName": "不同产品销售分布", "tables": [] }, { "widgetId": "fc1221d2d7484b5da4d107b489a84846", "widgetName": "项目销售面积分布", "tables": [] }, { "widgetId": "dadd44db04fd4872bdf701a1a8b636ed", "widgetName": "可售面积总数", "tables": [] } ] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示意 | |
上一篇：仪表板分享接口
