接口说明

    根据报告id,返回报告所在域、项目,使用到的数据模型,表、数据连接,过去七天访问量,过去七天访问人次等信息。

    权限说明

    使用 token 访问,只有项目管理员才能使用该接口

    基本信息

    请求路径
    API /api/dash/report/info
    请求方法 GET

    请求参数

    字段名称 参数类型 参数说明
    token String 用于鉴权
    reportId Number 报告id
    needStatisticInfo Optional(Bool) 是否返回统计信息(last7days和totalView),默认为true

    返回结果示例:

    {
      "code": 200,
      "result": {
        "domain": { //域信息
          "id": 1,
          "name": "netease"
        },
        "project": { //项目信息
          "id": 64464,
          "name": "猛犸测试项目"
        },
        "report": { //报告信息
          "id": 14377,
          "title": "权限测试"
        },
        "creator": { // 报告创建人信息
          "id": 123456,
          "nick": "张三",
          "uniqueId": "zhansan@corp.netease.com",
          "email": "zhansan@corp.netease.com"
        },
        "dataConnections": [ //数据连接信息
          {
            "userName": null,
            "type": "excel", //数据连接类型
            "port": null,
            "server": null,
            "namespace": null,
            "mammutCatalog": null,
            "id": 700315973,
            "name": "超市",
            "tables": [ //表
              {
                "status": "direct",
                "dataModelId": 700284409,
                "tableExprId": null,
                "database": null,
                "tableName": "订单",
                "dataConnectionId": 700315973,
                "produced": "Original",
                "fields": [ //字段
                  {
                    "field": "产品名称",
                    "dataType": "String"
                  },
                  {
                    "field": "制造商",
                    "dataType": "String"
                  },
                  {
                    "field": "发货日期",
                    "dataType": "DateTime"
                  },
                  {
                    "field": "国家",
                    "dataType": "String"
                  },
                  {
                    "field": "地区",
                    "dataType": "String"
                  },
                  {
                    "field": "城市",
                    "dataType": "String"
                  },
                  {
                    "field": "子类别",
                    "dataType": "String"
                  },
                  {
                    "field": "客户名称",
                    "dataType": "String"
                  },
                  {
                    "field": "省/自治区",
                    "dataType": "String"
                  },
                  {
                    "field": "细分",
                    "dataType": "String"
                  },
                  {
                    "field": "订单Id",
                    "dataType": "String"
                  },
                  {
                    "field": "订单日期",
                    "dataType": "DateTime"
                  },
                  {
                    "field": "邮寄方式",
                    "dataType": "String"
                  },
                  {
                    "field": "成本",
                    "dataType": "Whole"
                  },
                  {
                    "field": "折扣",
                    "dataType": "Decimal"
                  },
                  {
                    "field": "数量",
                    "dataType": "Whole"
                  },
                  {
                    "field": "类别代码",
                    "dataType": "Whole"
                  },
                  {
                    "field": "销售额",
                    "dataType": "Whole"
                  }
                ]
              }
            ]
          }
        ],
        "last7days": [
          {
            "date": "2023-09-09",
            "dayView": 0,
            "dayViewPerson": 0
          },
          {
            "date": "2023-09-10",
            "dayView": 0,
            "dayViewPerson": 0
          },
          {
            "date": "2023-09-11",
            "dayView": 0,
            "dayViewPerson": 0
          },
          {
            "date": "2023-09-12",
            "dayView": 0,
            "dayViewPerson": 0
          },
          {
            "date": "2023-09-13",
            "dayView": 0,
            "dayViewPerson": 0
          },
          {
            "date": "2023-09-14",
            "dayView": 0,
            "dayViewPerson": 0
          },
          {
            "date": "2023-09-15",
            "dayView": 1,
            "dayViewPerson": 1
          }
        ],
        "totalView": 15
      },
      "apiCost": 68,
      "logPath": "http://127.0.0.1:8009/operation/log/thNQ7UrwZogtjnbBtv3sKS"
    }

    接口说明

    根据报告ID获取用到的字段信息、指标信息、模型和数据连接信息

    基本信息

    属性
    API /platform/ext/reportTableInfo
    Method POST

    请求参数

    字段名称 参数类型 参数说明
    token String 鉴权信息
    reportId Number 报告ID

    调用示例

    {
        reportId: 12345
    }

    返回示例

    {
      "code": 200,
      "result": {
          "id": 20188,                                    // 报告ID
          "name": "czy趋势分析图",                 // 报告名称
          "components": [{
                "id": "c-nbCPxg77cQFQV1ELedcpQp",        // 组件ID
                "name": "产品_ID、城市、发货日期",            // 组件名称
                "fields": [
                    {
                        "dataConnectionId": 700318382,  // 组件用的数据连接ID
                        "tableName": "oN03-超市三万行-2022-09-09", // 表名
                          "database": "xxx", // 数据库名
                        "field": "产品_ID", // 字段名
                        "role": "Dimension", // 度量(Measure), 维度(Dimension)
                        "alias": "产品_ID",  // 字段别名
                        "comment": "产品_ID",  // 字段注释, 描述
                        "indicatorName": "xxx"  // 指标名称
                    }]
            }],
            "dataConnections": [{   // 数据连接信息
                "id": 700318245,
                "type": "excel",
                "host": null,
                "port": null,
                "userName": null,
                "parameters": null
          }],
          "dataModels": [            // 数据模型信息
              {
                  "id": 53259,
                  "name": "超市3万行",
                  "dataConnectionId": 700318382,
                  "config": {
                      "status": "direct",
                      "tables": [
                          {
                              "produced": "LogicalTable",
                              "logicalTableId": 1,
                              "tables": [
                                  {
                                      "tableId": 1,
                                      "tableAlias": "oN03-超市三万行-2022-09-09",
                                      "produced": "Original",
                                      "dataConnectionId": 700318382,
                                      "tableName": "oN03-超市三万行-2022-09-09",
                                      "logicalTableId": 1
                                  }
                              ]
                          }
                      ]
                  },
                  "pivotSchema": {}
              }
          ],
          "creator": {            // 报告创建者
              "id": 11834,
              "nick": "xxx",
              "uniqueId": "xxx@corp.netease.com"
          },
          "modifier": {        // 报告修改者
              "id": 11834,
              "nick": "xxx",
              "uniqueId": "xxx@corp.netease.com"
          }
      }