属性分析模型API

一、属性分析查询

接口URL

/api/open_api/v1/analysis/composition?token=xxx

请求方式

Content-Type

请求Query参数

请求Body参数

属性分析的请求参数由分析属性参数（composition）、全局筛选参数（filters）、分组统计参数（groups）、时区参数（timeZoneOffset）组成，特殊地，分组统计的方式有两种，分别为按分组项进行分组统计以及按人群对比进行分组统计

分析属性参数

extra参数解释

由于对象属性以及维度属性等存在父属性等关联属性，所以需要extra参数标识，为其他属性时，extra可以保持为空对象即{}，使用过程中，有参数疑问时，请联系DT团队

当为维度属性时

当为子属性（包含对象子属性，对象组子属性，列表子属性等）时

分组统计参数

按不同方式进行分组统计功能如下图所示, 

1️⃣ 按照分组项进行分组统计

当您选择按照表示按分组项进行分组统计即groupType为normal时， 分组项是一个用户相关的属性，故它的参数除了tableType不能为event以外，与通用的API查询参数说明中分组项一致

参数说明

2️⃣ 按照人群对比进行分组统计

参数说明

全局筛选与计算时区参数

请求响应结果

示例

我们以按照人群对比分组统计分析场景，进行API查询，那么最终返回结果如下示例

返回结果示例：

{
  "propertyDesc": "用户数",
  "values": [
    {
      "groupCol": [
        "人群1"
      ],
      "value": 13
    },
    {
      "groupCol": [
        "人群2"
      ],
      "value": 1461650
    }
  ],
  "groupDetail": {
    "groupType": "crowds",
    "groupNumber": 1,
    "groupCols": [],
    "groupColumns": [
      [
        "人群1",
        "人群2"
      ]
    ]
  }
}

响应结果说明

示例

我们以按照分组项分组统计分析场景，进行API查询，那么最终返回结果如下示例

返回结果示例：

{
  "propertyDesc": "用户数",
  "compositionDisplay": "",
  "values": [
    {
      "groupCol": [
        "总体"
      ],
      "value": 51709609
    }
  ],
  "groupDetail": {
    "groupType": "normal",
    "groupNumber": 1,
    "groupCols": [],
    "groupColumns": [
      [
        "总体"
      ]
    ]
  }
}

响应结果说明

响应结果说明

二、属性分析用户列表查询

在属性分析中， 我们可以查看按分组项或者人群对比进行分组统计的用户数

接口URL

/api/open_api/v1/analysis/composition_user_list?token=xxx

请求方式

Content-Type

请求Query参数

请求Body参数

请求的body参数在对应完整使用的属性分析的参数外，额外增加一项details和properties字段，来指明是按照什么进行分组统计的用户数

示例

下述示例，即表示在属性分析完成计算后，想要查看分组是"中国"、"ios"的用户数

{
  "firstEvent": {...},
  "returnEvent": {...},
  "alsoShow": {...},
  "eventsFilter":{...},
  "eventsGroup":{...},
  "eventsView": {...},
  "entity":{...},
  "timeZoneOffset": 8,
  "details": {
    "eventModel"："distribution",
    "sliceType": "user",
    "sliceGroup": [
      {
        "groupName": "国家",
        "groupValue": "中国",
        "tableType": "event",
      },
      {
        "groupName": "操作系统",
        "groupValue": "ios",
        "tableType": "event",
      }
    ]
  },
  "properties": [
    {"column_name": "#acid"},
    {"column_name": "#app_id"},
    {"column_name": "#app_version"},
    {"column_name": "#bundle_id"},
    {"column_name": "#carrier"},
    {"column_name": "#city"},
    {"column_name": "#dt_id"},
    {"column_name": "$uid"},
    {"column_name": "#country"}]
}

{
  "columnMeta": {
    "#acid": "账号 ID",
    "#app_id": "应用唯一标识",
    "#app_version": "应用版本",
    "#bundle_id": "应用包名",
    "#carrier": "运营商",
    "#city": "城市",
    "#country": "国家",
    "#dt_id": "访客ID",
    "$uid": "DT 用户 ID"
  },
  "total": 1,
  "data_list": [
    {
      "#acid": "0@5IZJI4YUWZcard_games",
      "#app_id": "dt_xxxx",
      "#app_version": "app2.0.1",
      "#bundle_id": null,
      "#carrier": "移动",
      "#city": "纽约",
      "#country": "中国",
      "#dt_id": "dddddd",
      "$uid": "123232455"
    },
  ],
}