---
description: 方舟5.1.0068版本中新增API
---
# Session分析
## 1. 接口地址
> 【POST】 /uba/api/sessions/analyze
## 2. 请求参数示例
接口请求参数，更多参数说明参照 查询API 中的 [通用参数](./#2-tong-yong-can-shu) 说明。
```java
{
// 【必填】指标 可以输入多个
"measures":[
{
//【必填】Session总体
"expression":"event.$Anything$Session",
//【必填】总次数
"aggregator":"SESSION_TOTAL_COUNT"
}
],
// 针对于所有指标的过滤条件，非必填
"filter":{
"conditions":[
{
//【必填】属性表达式
"expression":"user.xwho",
//【必填】条件操作符号
"function":"NOT_NULL",
"params":[
]
},
{
"expression":"session.$Anything.$platform",
"function":"EQ",
"params":[
"iOS",
"Android",
"JS"
]
}
],
"relation":"AND"
},
//【必填】用户分群 只支持查询单分群
"crowds":[
"$ALL"
],
//【必填】 时间范围-开始时间
"fromDate":"2020-07-03",
//【必填】 时间范围-结束时间
"toDate":"2020-07-09",
//查询结果是否使用缓存 true为使用缓存 false为重新查询
"useCache":true,
//抽样 这里表示全量
"samplingFactor":1,
//查看时间粒度 这里表示按日查看
"unit":"DAY",
//按XX维度查看，可以输入多个
"byFields":[
{
"expression":"session.$Anything.$platform"
}
],
//【必填】是否使用默认规则 true为使用默认规则 false为指定规则
"defaultRule":false,
//session规则 如果defaultRule=false，则需要指定session切割规则
"sessionRule":{
//【必填】参与session计算的事件
"events":[
"$pageview"
],
//【必填】超时切割时间，单位为分钟
"timeout":30,
//【必填】零点是否自动切割
"autoSplit":false,
//【必填】UID跨屏切割
"useUid":false,
//指定切割事件，当出现X事件时就算一次新session，不必填
"splitEvent": ""
}
}
```
>[info]**特殊说明：**
1、参数在示例中未标注必填的表示选填。
2、请求参数可以通过方舟产品生成，使用方法参照 [接口请求参数获取](./#3-jie-kou-qing-qiu-can-shu-kuai-jie-huo-qu)。
3、接口不支持日期对比和分群对比。
4、查询指标中如果包含时长的，如访问时长，停留时长等，返回结果的单位为毫秒。
**认证参数**：接口必传token和appKey两个参数，详情见[项目接口认证](../README.md)。
### 2.1 聚合表达式说明
> **aggregator：**聚合表达式，根据指标表达式是事件和属性而不同。
>
> * Session指标表达式：
>
> * **SESSION_TOTAL_COUNT** ：访问次数。
> * **SESSION_AVG_COUNT**：人均访问次数。
> * **SESSION_DURATION_SUM**：总访问时长。
> * **SESSION_PER_DEEPNESS_SUM**：单次访问深度。
> * **SESSION_BOUNCE_COUNT**：跳出次数。
> * **SESSION_BOUNCE_RATE**：跳出率。
> * **SESSION_DROPOUT_COUNT**：退出次数。
> * **SESSION_DROPOUT_RATE**：退出率。
> * **SESSION_AVG_DURATION**：人均访问时长。
> * **SESSION_AVG_DURATION**：人均访问时长。
> * **SESSION_PAGE_DURATION**：页面停留总时长。
> * **SESSION_PAGE_AVG_DURATION**：平均页面停留时长。
>
>
> * 属性表达式支持的聚合操作符如下：
> * **REMOVE_DUMPLICATE** ：表示去重数，支持所有数据类型。
> * **SUM**：总和，选定属性的属性值求和，例如加入购物车的商品金额之和，只支持数值类型。
> * **AVG**：均值，选定属性的属性值算数平均数，例如加入购物车的商品金额均值，只支持数值类型。
> * **MAX**： 最大值，选定属性的属性值最大值，例如加入购物车的商品最大金额，只支持数值类型。
> * **MIN** ：最小值，选定属性的属性值最小值，例如加入购物车的商品最小金额，只支持数值类型。
> * **AVG_PER**： 人均值，选定属性的属性值人均值，例如人均加入购物车的商品金额，只支持数值类型。
## 3. 返回结果示例
```java
{
//查询的指标，和输入一致
"measures": [
"event.$Anything.SESSION_TOTAL_COUNT",
"event.$Anything.SESSION_DURATION_SUM"
],
//查看维度，和输入一致
"byFields": [
"session.$Anything.$browser",
"session.$Anything.$platform"
],
//时间范围
"series": [
"2020-07-03",
"2020-07-04",
"2020-07-05",
"2020-07-06",
"2020-07-07",
"2020-07-08",
"2020-07-09"
],
//返回结果
"rows": [
{
//日期范围内合计，根据数组下标和 measures[]指标对应
"sum": [
11
],
//每日的指标结果，根据数组下标和measures[]指标对应
"values": [
//每日的具体指标数，根据下标和时间series[]下标对应
[
0,
0,
0,
0,
4,
0,
7
]
],
//具体维度分组结果
"byValue": [
"JS"
]
},
{
"sum": [
2
],
"values": [
[
0,
0,
0,
0,
2,
0,
0
]
],
"byValue": [
"iOS"
]
}
],
//查询时间
"reportUpdateTime": "2020-07-10 11:03:26"
}
```
## 4. 接口调用示例
```java
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
"measures":[
{
"expression":"event.$Anything$Session",
"aggregator":"SESSION_TOTAL_COUNT"
}
],
"filter":{
"conditions":[
{
"expression":"session.$Anything.$platform",
"function":"EQ",
"params":[
"iOS",
"Android",
"JS"
]
}
],
"relation":"AND"
},
"crowds":[
"$ALL"
],
"fromDate":"2020-07-06",
"toDate":"2020-07-12",
"useCache":true,
"samplingFactor":1,
"unit":"DAY",
"byFields":[
{
"expression":"session.$Anything.$platform"
}
],
"defaultRule":true
}' http://127.0.0.1:4005/ark/uba/api/sessions/analyze
```
- 产品简介
- 快速上手
- Step 1 安装部署
- Step 2 激活系统创建项目
- Step 3 开启您的分析旅程
- 1. 集成 SDK
- 2. 可视化埋点
- 3. 创建分析模型
- 附：埋点方案设计
- 附：数据分析思路
- 产品更新日志
- V5.5 新增LTV分析功能等
- V5.3 UI 升级、分布分析重构、维度表动态更新、细节优化等
- V5.2 新增归因分析、消息中心、重构埋点方案、优化看数据体验……
- V5.1.0317 体验优化& Bug修复
- V5.1 升级可视化埋点、增强权限控制……
- Part I 产品功能说明
- 名词解释
- 指标说明
- 看板
- 5.3.3 看板 UI 重构
- 分析
- 事件分析
- 渠道分析
- 渠道相关名词解释
- 来源识别规则
- 搜索引擎
- 社交媒体
- 小程序场景值
- Session 分析
- Session 规则
- 实时分析
- 留存分析
- 转化漏斗
- 智能路径
- 归因分析
- 热图分析
- Web/H5 热图
- APP 热图
- 分布分析
- 间隔分析
- 属性分析
- LTV 分析
- 多主体分析
- 自定义查询
- 用户
- 用户分群
- 用户探查
- 用户标签
- 标签体系应用概览
- 标签体系
- 标签生命周期管理
- 标签加工
- 如何自定义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插件
- uni-app SDK
- 快速集成
- 打包原生APP
- 开启移动端全埋点
- uni-app 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 注意事项
- 页面时长统计功能
- 飞书小程序 SDK
- 飞书小程序标准版
- 飞书小程序通用框架版
- Unreal Engine SDK
- 数据验证
- 客户端埋点验证
- Debug 数据验证
- 数据入库验证
- 数据导入
- 接口导入
- JAVA工具包
- 标准json文件导入
- csv格式导入
- 数据导入FAQ
- 数据导出
- JAVA工具包
- 事件数据导出
- 用户数据导出
- 直接从Kafka中消费数据
- 使用程序访问数据库
- 脚本工具
- API
- 分析API
- 事件分析
- 留存分析
- 自定义查询
- 转化漏斗
- 属性分析
- Session分析
- 渠道分析
- 分布分析
- 用户API
- 分群查询
- 用户档案
- 分群管理
- 管理API
- 权限管理
- 元数据管理
- 埋点方案管理
- 维度表管理
- 运营API
- 广告跟踪
- APP推广监测
- 平台管理API
- 项目管理
- 成员管理
- 第三方登录
- OAuth2.0登录
- LDAP登录
- GDPR 合规
- Part III 常见问题
- License 许可
- 产品试用及采购
- 参与贡献