方舟智能分析
产品功能SDK指南API
  • 产品简介
  • 快速上手
    • Step 1 安装部署
    • Step 2 激活系统创建项目
    • Step 3 开启您的分析旅程
      • 1. 集成 SDK
      • 2. 可视化埋点
      • 3. 创建分析模型
    • 附:埋点方案设计
    • 附:数据分析思路
  • 产品更新日志
    • V5.3.3 UI 升级、分布分析重构、维度表动态更新、细节优化等
    • V5.2.0 新增归因分析、消息中心、重构埋点方案、优化看数据体验……
    • V5.1.0317 体验优化& Bug修复
    • V5.1.0 升级可视化埋点、增强权限控制……
  • 我要反馈
  • 🐱Part I 产品功能说明
    • 名词解释
    • 指标说明
    • 看板
    • 分析
      • 事件分析
      • 渠道分析
        • 渠道相关名词解释
        • 来源识别规则
        • 搜索引擎
        • 社交媒体
        • 小程序场景值
        • Session 规则
      • Session 分析
      • 实时分析
      • 留存分析
      • 转化漏斗
      • 智能路径
      • 归因分析(Beta)
      • 热图分析
        • Web/H5 热图
        • APP 热图
      • 分布分析
      • 间隔分析
      • 属性分析
      • 自定义查询
    • 用户
      • 用户探查
      • 用户分群
      • 用户标签
        • 标签体系
        • 标签加工
          • 如何自定义SQL创建标签
        • 标签生命周期管理
        • 标签体系应用概览
      • 单用户档案
    • 运营
      • 电子邮件
      • 短信
      • 消息通知
      • 广告跟踪
      • App 推广监测(Beta)
    • 项目管理
      • 项目概览
      • 项目角色管理
      • 项目成员管理
      • 数据接入管理
        • 埋点方案
        • 可视化埋点
        • 集成SDK接入数据
        • 数据验证
        • 用户数据导入
      • 元数据管理
        • 元事件
        • 虚拟事件
        • 事件属性
        • 用户属性
        • Session 管理
        • 页面组管理
        • 维度表
      • 服务集成配置
      • 监控告警
        • 智能监控
        • 自定义监控
    • 平台管理
      • 企业概览
      • 项目管理
      • 成员管理
      • 安全设置
      • 企业设置
      • 日志管理
      • 帐号设置
  • 🐵Part II 技术文档
    • 技术接入准备工作
      • 部署环境检测工具
      • 数据模型
      • 数据格式
      • 预置事件和属性
        • App预置事件/属性
        • JS 预置事件/属性
      • 如何准确识别用户
      • 如何设计埋点方案
      • 分平台上报数据 vs 跨平台打通
    • SDK 指南
      • Android SDK
        • 快速集成
        • 全埋点模块
        • 消息推送模块
        • Android Hybrid模式
        • SDK Gradle集成方式
        • 多渠道打包
        • 易观小工具
        • 合规相关
      • iOS SDK
        • 快速集成
        • 全埋点介绍
        • iOS Hybrid模式
        • 消息推送模块
      • JS SDK
        • 快速集成
        • JS SDK基础版
        • JS SDK插件
      • 微信小程序 SDK
        • 快速集成
        • 微信小程序标准版
        • 微信小程序插件版
        • 微信小程序通用框架版
      • 支付宝小程序 SDK
        • 支付宝小程序标准版
        • 支付宝小程序通用框架版
      • 字节跳动小程序 SDK
        • 字节跳动小程序标准版
        • 字节跳动小程序通用框架版
      • 百度小程序 SDK
        • 百度小程序标准版
        • 百度小程序通用框架版
      • 钉钉小程序 SDK
        • 钉钉小程序标准版
        • 钉钉小程序通用框架版
      • QQ小程序 SDK
        • QQ小程序标准版
        • QQ小程序通用框架版
      • 快应用 SDK
      • 华为WeCode小程序
        • WeCode SDK 标准版
        • WeCode SDK插件
      • PhoneGap SDK
      • mPaaS SDK
      • ReactNative SDK
      • Flutter SDK
      • Java SDK
      • Python SDK
      • PHP SDK
      • C++ SDK
      • C# SDK
      • Node JS SDK
      • Lua SDK
      • Golang SDK
      • SDK FAQ
        • identify与alias的区别
        • 爬虫数据如何识别?
        • 页面停留如何获取时间?
        • 如果获取SDK及更新日志
        • 代码埋点和无埋点有什么区别
        • Web页面中发现丢失某一个事件
        • 自研 SDK 注意事项
        • 页面时长统计功能
    • 数据验证
      • 客户端埋点验证
      • Debug 数据验证
      • 数据入库验证
    • 数据导入
      • 接口导入
      • JAVA工具包
        • 标准json文件导入
        • csv格式导入
      • 数据导入FAQ
    • 数据导出
      • JAVA工具包
        • 事件数据导出
        • 用户数据导出
      • 直接从Kafka中消费数据
      • 使用程序访问数据库
    • 脚本工具
    • API
      • 分析API
        • 事件分析
        • 留存分析
        • 转化漏斗
        • 属性分析
        • Session分析
        • 渠道分析
        • 分布分析
        • 自定义查询
      • 用户API
        • 分群查询
        • 用户档案
        • 分群管理
      • 管理API
        • 权限管理
        • 元数据管理
        • 埋点方案管理
        • 维度表管理
      • 运营API
        • 广告跟踪
      • 平台管理API
        • 项目管理
        • 成员管理
    • 第三方登录
      • OAuth2.0登录
      • LDAP登录
    • GDPR 合规
  • �� Part III 常见问题
    • License 许可
    • 产品试用及采购
    • 参与贡献
由 GitBook 提供支持
在本页
  • 1. 接口地址
  • 2. 请求参数示例
  • 2.1 聚合表达式说明
  • 3. 返回结果示例
  • 4. 接口调用示例

这有帮助吗?

  1. Part II 技术文档
  2. API
  3. 分析API

属性分析

方舟4.5.1版本中新增API

上一页转化漏斗下一页Session分析

最后更新于5年前

这有帮助吗?

1. 接口地址

【POST】 /uba/api/userAttributes/analyze

2. 请求参数示例

接口请求参数,更多参数说明参照 查询API 中的 说明。

{
    // 【必填】查询指标,含用户数和某用户属性的去重数等
    "measure":{
        //在获取某个属性的聚合结果时候才需要填
        "expression":"",
        //【必填】聚合操作符 这里表示用户数
        "aggregator":"USER_COUNT"
    },
    //【必填】用户分群
    "crowds":[
        "$ALL"
    ],
    //使用缓存 这里表示是
    "useCache":true,
    "limit":50,
    // 针对于指标的过滤条件,非必填,只能选择用户属性
    "filter":{
        "conditions":[
            {
                "expression":"user.xwho",
                "function":"NOT_NULL",
                "params":[
​
                ]
            }
        ],
        "relation":"AND"
    },
    //按XX维度查看,可以输入多个,可以为空,只能选择用户属性
    "byFields":[
        {
            "expression":"user.$city"
        }
    ]
}

特殊说明:

1、参数在示例中未标注必填的表示选填。

3、接口不支持日期对比和分群对比。

4、属性分析中的所有表达式都为用户属性表达式,只支持用户属性的查看、过滤。

2.1 聚合表达式说明

aggregator:聚合表达式,支持查看总用户数或某个属性的聚合结果。

  • 不需要表达式查看总体的聚合操作符如下:

    • USER_COUNT :用户数。

  • 用户属性表达式支持的聚合操作符如下:

    • REMOVE_DUMPLICATE :表示去重数,支持所有数据类型。

    • SUM:总和,选定属性的属性值求和,例如加入购物车的商品金额之和,只支持数值类型。

    • AVG:均值,选定属性的属性值算数平均数,例如加入购物车的商品金额均值,只支持数值类型。

    • MAX: 最大值,选定属性的属性值最大值,例如加入购物车的商品最大金额,只支持数值类型。

    • MIN :最小值,选定属性的属性值最小值,例如加入购物车的商品最小金额,只支持数值类型。

    • AVG_PER: 人均值,选定属性的属性值人均值,例如人均加入购物车的商品金额,只支持数值类型。

3. 返回结果示例

//一、无细分维度(查看用户数)
{
    "rows": [
        {
            //指标查询结果
            "value": 88399,
            "byValue": []
        }
    ],
    "measure": "USER_COUNT",
    "byFields": [],
    "reportUpdateTime": "2019-10-09 11:19:40"
}
​
//二、有细分维度
{
    //查询结果
    "rows": [
        {
            //维度对应的指标值
            "value": 27206,
            //维度分类
            "byValue": [
                "2018-05-07 00:00:00"
            ]
        },
        {
            "value": 7683,
            "byValue": [
                "2018-05-08 00:00:00"
            ]
        },
        {
            "value": 5859,
            "byValue": [
                "2018-05-10 00:00:00"
            ]
        },
        {
            "value": 5277,
            "byValue": [
                "2018-05-09 00:00:00"
            ]
        },
        {
            "value": 3548,
            "byValue": [
                "2018-05-11 00:00:00"
            ]
        }
    ],
    //查询的指标
    "measure": "USER_COUNT",
    //按照首次访问时间查看
    "byFields": [
        "user.$first_visit_time"
    ],
    "reportUpdateTime": "2019-10-09 11:24:34"
}

4. 接口调用示例

curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
    "measure":{
        "aggregator":"USER_COUNT"
    },
    "useCache":true,
    "limit":50,
    "crowds":[
        "$ALL"
    ],
    "byFields":[
​
    ]
}' http://127.0.0.1:4005/uba/api/userAttributes/analyze

2、请求参数可以通过方舟产品生成,具体参照 。

认证参数:接口必传token和appKey两个参数,详情见 。

🐵
项目接口认证
通用参数
接口请求参数获取