儀表板資訊API

概述

版本

FineBI伺服器版本
功能變更
6.0-

功能簡介

本文講解FineBI中儀表板資訊相關API。

獲取使用者資訊和使用者建立的儀表板

API簡介



API作用獲取使用者資訊和使用者建立的儀表板
APIURL/v5/api/dashboard/user/info
請求類型GET

回应實體



請求範例

http://172.17.0.25:37799/webroot/decision/v5/api/dashboard/user/info?fine_auth_token=xxx

注：使用API時需要登入，需要傳遞token參數。

回应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "userInfo": {

            "displayName": "麗莎(Lisa)",

            "postNames": [

                "銷售主管"

            ],

            "departmentNames": [

                "銷售部"

            ],

            "customRoleNames": [

                "普通角色"

            ],

            "departmentPosts": [

                {

                    "jobTitle": "銷售主管",

                    "departments": "銷售部"

                }

            ]

        },

        "dashboards": [

            {

                "reportId": "8bb79578cfc2418d910e73cfcea8d415",

                "name": "範例儀表板",

                "initTime": 1669171806820,

                "lastUpdateTime": 0,

                "createBy": "9bdd489c-518b-40f8-8566-786f78ffe64a",

                "watermark": true

            }

        ]

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截圖示意

發佈管理節點所有儀表板資訊

API簡介



API作用獲取發佈管理節點下的儀表板資訊
APIURL/v5/api/dashboard/search
請求類型GET
注意事項使用該API的使用者，必須有發佈管理節點權限

請求參數-Query參數

參數名
參數值是否必填
page發佈管理的頁面頁碼是
count每頁資訊數量是

回应實體



請求範例

http://172.17.0.25:37799/webroot/decision/v5/api/dashboard/search?page=2&count=1&fine_auth_token=xxx

注：使用API時需要登入，需要傳遞token參數。

回应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "reportIndexList": [

            {

                "userInfo": {

                    "displayName": "1(1)",

                    "postNames": [],

                    "departmentNames": [],

                    "customRoleNames": [

                        "superusers"

                    ],

                    "departmentPosts": []

                },

                "reportIndex": {

                    "reportId": "b86db205e71b40d3b1f08f194f44084f",

                    "name": "新儀表板",

                    "initTime": 1669111495607,

                    "lastUpdateTime": 0,

                    "createBy": "b5f0c2ee-640f-4039-a4d4-918b55354898",

                    "watermark": true

                }

            }

        ],

        "applyingCount": 2,

        "totalCount": 74

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截圖示意

獲取主題下的儀表板列表

API簡介



API作用獲取某個主題下的儀表板列表
APIURL/v5/api/platform/dashboard/list
請求類型GET

請求參數-Query參數

參數名
參數值是否必填
subjectId主題ID
是

回应實體



請求範例

http://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/list?subjectId=5540f238907b472bbedd7595e0260614&fine_auth_token=xxx

注：使用API時需要登入，需要傳遞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": "1",

                    "shared": false,

                    "publishStatus": 1,

                    "editable": true,

                    "publicLink": {

                        "shared": false,

                        "passProtected": false,

                        "deadline": 0

                    },

                    "parentId": "5540f238907b472bbedd7595e0260614",

                    "position": "我的分析/行業應用/地產建築/地產公司資料監視",

                    "coopAnalysis": false,

                    "creatorAuth": true

                },

                {

                    "name": "集團CEO看板",

                    "initTime": 1533289033311,

                    "lastUpdateTime": 0,

                    "id": "e9bf9ea3f0de40d08281ebc9753f4942",

                    "createBy": "1",

                    "shared": false,

                    "publishStatus": 1,

                    "editable": true,

                    "publicLink": {

                        "shared": false,

                        "passProtected": false,

                        "deadline": 0

                    },

                    "parentId": "5540f238907b472bbedd7595e0260614",

                    "position": "我的分析/行業應用/地產建築/地產公司資料監視",

                    "coopAnalysis": false,

                    "creatorAuth": true

                }

            ]

        },

        "widgets": {

            "availableWidgets": []

        },

        "customOrder": [

            "6aae904df9284bef823921fac05fb247",

            "e9bf9ea3f0de40d08281ebc9753f4942",

            "88f951b8fba9420987a7a4d1f8b3118e",

            "db95858000e448ea8c376eee7ae9ed64",

            "9de231867ad440768d3416bfe6ead38c"

        ],

        "tableCustomOrder": [],

        "customHide": [],

        "parentId": "bcf238bf6c354346863591f0039d7a88"

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截圖示意

獲取儀表板資訊

API簡介



API作用獲取儀表板的資訊
APIURL/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://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/reports/info?info=%7B%22index%22%3A%5B%7B%22id%22%3A%226aae904df9284bef823921fac05fb247%22%7D%5D%7D&fine_auth_token=

注：使用API時需要登入，需要傳遞token參數。

回应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "index": [

            {

                "name": "地產公司銷售監視",

                "initTime": 1533632466066,

                "lastUpdateTime": 0,

                "id": "6aae904df9284bef823921fac05fb247",

                "createBy": "1",

                "shared": false,

                "publishStatus": 0,

                "editable": false,

                "publicLink": {

                    "shared": false,

                    "passProtected": false,

                    "deadline": 0

                },

                "coopAnalysis": false,

                "creatorAuth": false

            }

        ]

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截圖示意

獲取儀表板中所有組件資訊

API簡介



API作用獲取儀表板中所有組件的資訊
APIURL/v5/api/dashboard/report/consanguinity
請求類型GET

請求參數-Query參數

參數名
參數值是否必填
reportId儀表板ID是

回应實體



請求範例

http://172.17.0.25:37799/webroot/decision/v5/api/dashboard/report/consanguinity?reportId=6aae904df9284bef823921fac05fb247&fine_auth_token=xxx

注：使用API時需要登入，需要傳遞token參數。

回应成功

{

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "reportId": "6aae904df9284bef823921fac05fb247",

        "reportName": "地產公司銷售監視",

        "widgets": [

            {

                "widgetId": "ffcfdc7d9317448197cfadb1d3d1f227",

                "widgetName": "不同產品銷售分佈",

                "tables": []

            },

            {

                "widgetId": "cdf2e3759bac4d7f86f935b2f4bc8eef",

                "widgetName": "不同季度銷售趨勢",

                "tables": []

            },

            {

                "widgetId": "23549d648872405989c88c009ced0d41",

                "widgetName": "未命名組件2",

                "tables": []

            },

            {

                "widgetId": "4c11d91e808d450bb315e4eeea52d761",

                "widgetName": "不同年份房間/合同/標準總價",

                "tables": []

            },

            {

                "widgetId": "121e60da8bd44699b66e0ea7c793c901",

                "widgetName": "項目剩餘庫存面積",

                "tables": []

            },

            {

                "widgetId": "fac6c24a3ab440f5a40a055eb478efda",

                "widgetName": "銷售面積總數",

                "tables": []

            },

            {

                "widgetId": "9717dba9f23b4bdd839b2522f6209342",

                "widgetName": "銷售明細",

                "tables": []

            },

            {

                "widgetId": "d86364e75b6e447c9b7c327407fa6bb2",

                "widgetName": "項目總數",

                "tables": []

            },

            {

                "widgetId": "0e8fe0d307d847129528f708b925f6e2",

                "widgetName": "省份銷售分佈",

                "tables": []

            },

            {

                "widgetId": "36417a1ac5184b7f94b982ac78aecd11",

                "widgetName": "不同合同類型分佈",

                "tables": []

            },

            {

                "widgetId": "fc1221d2d7484b5da4d107b489a84846",

                "widgetName": "項目銷售面積分布",

                "tables": []

            },

            {

                "widgetId": "dadd44db04fd4872bdf701a1a8b636ed",

                "widgetName": "可售面積總數",

                "tables": []

            }

        ]

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截圖示意


附件列表


主题： 部署整合
已经是第一篇
已经是最后一篇
  • 有帮助
  • 没帮助
  • 只是浏览
  • 圖片不清晰
  • 用語看不懂
  • 功能說明看不懂
  • 操作說明太簡單
  • 內容有錯誤
中文（简体） English 日本語
中文（繁體）

滑鼠選中內容，快速回饋問題

滑鼠選中存在疑惑的內容，即可快速回饋問題，我們將會跟進處理。

不再提示

10s後關閉

獲取幫助
線上支援
獲取專業技術支援，快速幫助您解決問題
工作日9:00-12:00，13:30-17:30在线
頁面反饋
針對當前網頁的建議、問題反饋
售前咨詢
獲取報價：
FineReport FineBI
預約演示：
FineReport FineBI
業務咨詢
電話：0933-790886或 0989-092892
郵箱：taiwan@fanruan.com
頁面反饋
*問題分類
不能為空
問題描述
0/1000
不能為空

反馈已提交

网络繁忙