查询看板中的报表信息--增长分析（私有化）-火山引擎

文档中心

立即注册

导航

增长分析（私有化）

查询看板中的报表信息

最近更新时间：2025.07.16 15:56:14首次发布时间：2025.07.16 15:56:14

请求说明

Path：/openapi/v1/{app_id}/dashboards/{dashboard_id}/reports
Method: GET
Content-type: application/json

请求参数

Path-parameters:

Parameter	Type	Description	Required
dashboard_id	string	看板ID	true

返回参数

Response:

{
    "code":200,
    "data":{
        "7017737980265628173":{
            "available":3,
            "denied":0,
            "layout":Array[3],
            "reports":[
                {
                    "app_id":"164314",
                    "creator":"",
                    "dsls":Array[1],
                    "is_preset":true,
                    "partner_info":{

                    },
                    "partners":[

                    ],
                    "report_id":"7017737978126696967",
                    "report_name":"\u6d3b\u8dc3vs\u65b0\u7528\u6237",
                    "report_type":"event_analysis"
                },
                Object{...},
                Object{...}
            ],
            "total":3
        }
    },
    "message":"success"
}

字段含义说明

Field	Type	Description
reports	JSON 对象数组	看板下的多个报表信息
reports[].dsls	JSON 对象数组	报表的DSL信息
reports[].report_id	string	报表的ID
reports[].report_name	string	报表的名称
reports[].report_type	string	报表类型。

说明

返回的report_type为rich_text（富文本）或者embed（嵌入式）时，报表详情内容已包含在返回的reports[].dsls信息中，无需再通过report_id进一步查询此类报表详情。

请求示例

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

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

返回结果：