Skip to content

数据洞察 - 关键维度

本接口在 v24.12 版本中引入

  • 本接口用于成员查询 单指标 的同环比中影响数据的关键维度
  • 在调用本接口前,确保你已经创建了工作区,并且用户加入了工作区成为了成员

请求方式

Request Method: POST
Request URL:    /openapi/v1/workspaces/{workspaceId}/data/attribution-dimensions/
Request Header:
  Authorization: "{连接密钥}"

请求参数

{
  "memberUid": "{memberUid}",
  "question": "{question}",
  "comparisonType": "yoy"
}

请求参数说明

参数 类型 是否必填 说明
workspaceId string 是 工作区的 id
memberUid string 是 工作区中成员的 uid
question string 是 问题,需要包含 时间范围 和 单指标,比如“今年净营业额”
comparisonType string 是 对比类型,yoy - 同比,ring - 环比
连接密钥 string 是 API密钥

返回结果

正常情况下返回结果如下:

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "title": "净营业额同比",
    "insight": "我们从不同维度对净营业额进行了分析,北京、上海、江苏、天津、河南、2006-01-21、金融街净营业额的增长可能造成了显著高于其它周的影响。",
    "description": "以下维度数据变化显著,是导致净营业额变化最有可能的原因",
    "subTitle": "2024-02-25 至 03-25",
    "measure": {
      "name": "净营业额",
      "value": 0,
      "format": "float",
      "currencyCode": "CNY",
      "subTitle": "",
      "cumulative": false
    },
    "measureDelta": 134668908.5536456,
    "measureDimensionMaxDelta": 43538786.44677132,
    "rows": [
      {
        "rank": 1,
        "dimension": "省",
        "attr": "北京",
        "mask_key": "",
        "measurePrevious": 324629749.57468724,
        "measureCurrent": 368168536.02145857,
        "text": "北京",
        "units": [
          {
            "tokens": [
              {
                "word": "前30天",
                "prop": "dateBefore_30d"
              }
            ]
          },
          {
            "tokens": [
              {
                "word": "营业额",
                "prop": "m17"
              }
            ]
          },
          {
            "tokens": [
              {
                "word": "北京",
                "prop": "d1.F=5YyX5Lqs"
              }
            ]
          }
        ]
      },
      {
        "rank": 2,
        "dimension": "省",
        "attr": "上海",
        "mask_key": "",
        "measurePrevious": 336211627.755625,
        "measureCurrent": 371107752.8740625,
        "text": "上海",
        "units": [
          {
            "tokens": [
              {
                "word": "前30天",
                "prop": "dateBefore_30d"
              }
            ]
          },
          {
            "tokens": [
              {
                "word": "营业额",
                "prop": "m17"
              }
            ]
          },
          {
            "tokens": [
              {
                "word": "上海",
                "prop": "d1.F=5LiK5rW3"
              }
            ]
          }
        ]
      },
      {
        "rank": 3,
        "dimension": "省",
        "attr": "江苏",
        "mask_key": "",
        "measurePrevious": 156901546.7808333,
        "measureCurrent": 178744640.14416665,
        "text": "江苏",
        "units": [
          {
            "tokens": [
              {
                "word": "前30天",
                "prop": "dateBefore_30d"
              }
            ]
          },
          {
            "tokens": [
              {
                "word": "营业额",
                "prop": "m17"
              }
            ]
          },
          {
            "tokens": [
              {
                "word": "江苏",
                "prop": "d1.F=5rGf6IuP"
              }
            ]
          }
        ]
      }
    ]
  }
}

因为参数错误或者其他情况,可能返回错误信息,需要根据提示处理。