API(应用程序接口)是一些预先定义的函数,或指软件系统不同组成部分衔接的约定。目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问原码,或理解内部工作机制的细节。
近日,易观方舟4.5.1版本新增「属性分析API」,用户可在使用属性分析功能时,通过操作系统的帮助,快速、有效、安全、可靠地操纵计算机系统中的各类资源,以处理自己的程序。
API分为分析API、用户API、管理API、平台管理API四大类。此前,API已经历5次迭代优化,此次更新的「属性分析API」,就分属于分析API这一类中。
API优化进程
- 3.4版本,新增了查询 API 和功能 API,满足调用方舟数据结果自定义嵌入其他系统的需求;
- 4.1版本,新增管理类API;
- 4.2版本,新增平台类API;
- 5.0版本,新增分群管理API;
- 5.1版本,新增属性分析API;
接口分类
API分为分析API、用户API、管理API、平台管理API四大类。
- 分析API:通过各分析模型获取数据。
- 用户API:用户分群的创建、获取分群的用户详情等。
- 管理API:项目元事件、用户属性、项目成员管理等。
- 平台管理API:项目列表获取、项目创建、平台成员新增。
属性分析API接口地址
【POST】 /uba/api/userAttributes/analyze
请求参数示例
接口请求参数,更多参数说明参照查询API 中的通用参数说明。
特别说明:
- 参数在示例中未标注必填的表示选填
- 请求参数可以通过方舟产品生成
- 接口不支持日期对比和分群对比
- 属性分析中的所有表达式都为用户属性表达式,只支持用户属性的查看、过滤
认证参数:接口必传token和appKey两个参数。
聚合表达式说明:
aggregator:聚合表达式,支持查看总用户数或某个属性的聚合结果。
不需要表达式查看总体的聚合操作符如下:
USER_COUNT :用户数。
用户属性表达式支持的聚合操作符如下:
- REMOVE_DUMPLICATE :表示去重数,支持所有数据类型。
- SUM:总和,选定属性的属性值求和,例如加入购物车的商品金额之和,只支持数值类型。
- AVG:均值,选定属性的属性值算数平均数,例如加入购物车的商品金额均值,只支持数值类型。
- MAX: 最大值,选定属性的属性值最大值,例如加入购物车的商品最大金额,只支持数值类型。
- MIN :最小值,选定属性的属性值最小值,例如加入购物车的商品最小金额,只支持数值类型。
- AVG_PER: 人均值,选定属性的属性值人均值,例如人均加入购物车的商品金额,只支持数值类型。
返回结果示例
接口调用示例
欢迎体验易观方舟新增功能~