接口说明:

    用于将图表数据导出为excel,这里需要注意的,导出接口用户在页面上临时的选择,无法实现导出

    基本信息:

    API /api/dash/report/exportExcel
    Method GET

    请求参数:

    字段名称 参数类型 参数说明
    token String 鉴权token
    reportId Int 报告id
    type String type="report",表示是导出报告,type="dashboard",表示导出报告页,type="component",表示导出图表组件
    componentId String(Optional) 组件id,如果type="component",必传
    exportType String(Optional) 非必填,'csv', 'xlsx', 'crossTable',三者选其一,不传值默认是xlsx
    dashboardId Number (Optional) 页面id,如果type="dashboard",必传
    enhance Bool(Optional) 是否导出带样式,true-带样式,false-不带样式,默认true
    conditionFormat Bool(Optional) 是否导出条件格式,enhance为true时生效。true-导出条件格式。false不导出,默认false
    useOriginData Bool(Optional) 是否导出数据格式及日期格式,true-使用原始数据,false-导出数据格式及日期格式,默认false
    includeTitle Bool (Optional) 是否导出图表标题,true-导出,false-不导出, 默认false
    rowsLimit Number(Optional) 导出行数。导出类型为xlsx时,可以使用此字段。默认为设置的默认导出行数限制
    title String(Optional) | 导出文件名称 |
    defaultFilters filters(Optional) 筛选器,与导出图片和pdf接口中的defaultFilters字段格式一致
    excelSplitLimit Number (Optional) 当导出单个图表组件时,可以使用此参数配置条数拆分导出成多个Excel导出 |
    tempQueryId String (Optional) 临时筛选ID,如果客户在报告做了一些临时筛选等操作,可以通过在集成iframe 的postMessage的方式拿到这个ID,就可以导出筛选后的数据, postMessage具体格式参考前端开放API能力|
    {
        "token": "1503575355359c4fdea8ec1683ed10edd91ae",
        "exportType": "xlsx",
        "reportId": 14986,
        "type": "dashboard",
        "dashboardId": 23330,
        "useOriginData": false,
        "includeTitle": true,
        "title": "API导出excel",
        "tempQueryId": "export_2ff50084b2e9ac865f3779c6ecd7c4d6",
        "defaultFilters": {
            "c-bQo8b75xnJqmhvnJpYNXtW": {
                "selected": [
                    "2020",
                    "2021",
                    "2022",
                    "2023"
                ],
                "exclude": false
            },
            "c-gJLpNWPGADEg1Gx5zZBGHk": {
                "type": "StaticTime",
                "minBound": "2022-02-02 00:00:00",
                "maxBound": "2023-03-12 24:00:00"
            }
        }
    
    }

    成功数据返回:

    {
        "code": 200,
        "result": {
            "link": "...",   // 下载地址
            "taskId": 5362,   // 导入任务id
            "sheetInfos": [     // sheet信息
                {
                    "dataLine": 54,
                    "fieldNames": [   // 字段名列表
                        "地区",
                        "类别",
                        "细分",
                        "折扣"
                    ]
                }
            ],
            "exportFileName": "未命名报告-折扣(按细分、地区、类别划分)_20241104:49",    // 导出文件名
            "emptyData": false    // 只要存在一个导出组件的数据为空,该字段就返回true
        }
    }