查询看板信息--增长分析 DataFinder-火山引擎

文档中心

导航

增长分析 DataFinder

查询看板信息

最近更新时间：2025.08.25 19:25:40首次发布时间：2024.06.30 18:36:01

请求说明

Path：不同环境的请求路径的设置方式不同：

环境类型	路径
SaaS-云原生	使用项目ID作为路径参数（推荐）：/openapi/v1/projects/{project_id}/dashboards/{dashboard_id} 使用应用ID作为路径参数：/openapi/v1/{app_id}/dashboards/{dashboard_id}
SaaS-云原生	/openapi/v1/{app_id}/dashboards/{dashboard_id}

说明

如果您不确定您当前使用的是哪个环境，可参考文档先确认下当前使用的环境类型：SaaS云原生/非云原生&私有化环境。

Method: GET
Content-type: application/json

请求参数

Path-parameters:

参数	类型	是否必选	示例值	描述
dashboard_id	string	是	6737549040994484743	看板ID

返回参数

Response:

{
    "code":200,
    "data":{
        "6737549040994484743":{
            "is_core":false,
            "creator":"数据漫游者",
            "partner_info":{},
            "created_at":1568707880,
            "filters":[],
            "is_default":false,
            "partners":[],
            "extra":{},
            "name":"核心数据总览",
            "is_public":true,
            "is_subscribed":false,
            "app_id":164314,
            "dashboard_id":"6737549040994484743",
            "status":1
        }
    },
    "message":"success"
}

字段含义说明：
data 返回的是一个JSON 对象，格式是："{dashboard_id}":{dashboard_info}，针对看板信息的关键字段进行说明

参数	类型	示例值	描述
name	string	核心数据总览	看板名称

请求示例

bc 为创建的 RangersClient, 其初始化请参考使用说明，各语言的 SDK 都提供了类似的接口
调用(Python)：

# 例如，app_id= 164314 dashboard= 6737549040994484743
bc.data_finder('/openapi/v1/164314/dashboards/6737549040994484743', method='get')
print(res.content)

返回示例

返回结果：

{
    "code":200,
    "data":{
        "6737549040994484743":{
            "is_core":false,
            "creator":"数据漫游者",
            "partner_info":{

            },
            "created_at":1568707880,
            "filters":[

            ],
            "is_default":false,
            "partners":[
                "数据漫游者1",
                "数据漫游者2"
            ],
            "extra":{

            },
            "name":"核心数据总览",
            "is_public":true,
            "is_subscribed":false,
            "app_id":164314,
            "dashboard_id":"6737549040994484743",
            "status":1
        }
    },
    "message":"success"
}