本文档所描述的内容属于神策分析的高级使用功能,涉及较多技术细节,适用于对相关功能有经验的用户参考。如果对文档内容有疑惑,请咨询神策值班同学获取一对一的协助。


查询 API 主要用于获取各种数据分析报告。

调用方法

请参见 API 文档 中的调用方法描述。

 通用参数

属性表达式

几乎所有的 API 都会用到属性表达式,例如按照某个属性进行过滤、分组或者聚合等等。属性包括事件属性和用户属性,事件属性使用 event.事件名.属性名 的方式,例如表示 页面浏览的页面标题 这个属性的表达式如下:

示例展示
event.$pageview.$title

用户属性类似,例如表示 用户性别:

示例展示
user.Gender

筛选表达式

筛选表达式同样适用于绝大多数 API,用于表示对某些事件或者用户的筛选操作,使用如下格式的 JSON 表示:

示例展示
{
// 表示 conditions 里的各个条件的关系是 "或" 还是 "且" "relation": "and",
// 具体的条件列表,可以有多个 "conditions": [ {
// 条件的左值,是一个属性表达式 "field": "event.BuyGold.$os",
// 条件的操作符,这里表示等于 "function": "equal",
// 条件的参数,根据不同的操作符可以有一个或者多个 "params": [ "iOS" ] }, { "field": "user.Gender", "function": "equal", "params": [ "男" ] } ] }


目前支持的操作符如下:

  • equal / notEqual

        表示等于/不等于,对字符串、数值类型有效。如果 Params 有多个,则相当于 In 或者 Not In。例如想筛选出来自北京或者上海的用户:

示例展示
{
  "field": "user.$city", 
  "function": "equal", 
  "params": [
    "北京", 
    "上海"
  ]
}


  •  isTrue / isFalse

        只对布尔类型有效。

  •  isSet / notSet

        某个属性是否有值,对字符串、数值类型有效。

  •  include

        针对集合的操作,表示包含某个元素,例如筛选出所有喜欢苹果的用户:

示例展示
{
  "field": "user.FavoriteFruits", 
  "function": "include", 
  "params": [
    "Apple"
  ]
}


  •  less / greater / between:表示小于/大于/小于且大于,其中 between 是前闭后闭的区间,只对数值类型有效。例如筛选买入黄金的价格在 230 和 232 之间的所有事件:
示例展示
{
  "field": "event.BuyGold.GoldPrice", 
  "function": "between", 
  "params": [
    230, 
    232
  ]
}


  • contain / notContain

        包含或者不包含,表示字符串的部分匹配,只对字符串类型有效。

  • absoluteBetween / relativeBefore / relativeWithin

        针对日期类型的操作符,分别表示在一个绝对日期范围/在 N 天之前/在 N 天之内。例如想筛选所有注册时间在 3 天之内的用户:

示例展示
{
  "field": "user.$signup_time", 
  "function": "relativeWithin", 
  "params": [
    3
  ]
}


        或者筛选所有在 2015-1-1~2015-1-10 注册的用户:

示例展示
{
  "field": "user.$signup_time", 
  "function": "absoluteBetween", 
  "params": [
    "2015-01-01", 
    "2015-01-10"
  ]
}


参数说明

参数名参数含义取值范围是否必须字段
aggregator聚合操作符

general:事件触发次数

unique:触发用户数 

average/uniqAvg:人均次数/人均值 

sum:数值总和

max:数值最大值 

min:数值最小值 

avg:数值平均值

Y
event_name事件名元数据中的事件名,事件必须是可见的Y
filter查询指标的筛选条件


N
field聚合的字段名若 aggregator 为 sum/max/min/avg,需要添加 field 字段,即聚合的字段名,与 aggregator 同级,例如:“field" : "event.payOrder.discountAmount"N
by_fields按某个属性分组展示事件的属性名N
bucket_params分桶条件对数值型属性进行分组时,可以自定义分桶条件,分桶条件里所包含的属性必须全包含在分组属性“by_fields”
unit指标查询的时间粒度hour,day,week,month (目前 API 不支持 minute 分组级别的查询,最小时间粒度是 hour )Y
from_date/to_date查询开始时间/查询结束时间

所有分析接口中都支持使用”天级精度“进行筛选,仅漏斗分析中支持 "from_date" 与 "to_date" 使用"秒级精度"或"天级精度"进行筛选。

示例:

// 使用秒级精度

"from_date": "2021-07-17 22:00:00", "to_date" : "2021-07-18 22:00:00", - 系统将会匹配出时间范围为 2021-07-17 22:00:00.000 至 2021-07-18 22:00:00.999 的全部数据

// 使用天级精度

"from_date": "2021-07-17", "to_date" : "2021-07-18", - 系统将会匹配出时间范围为 2021-07-17 00:00:00.000 至 2021-07-18 23:59:59.999 的全部数据

Y
slice_by_values和 by_fields 相对应,按某个属性分组查看时,如果只想查看某个属性值的触发用户数时,使用此参数指定。by_fields 中属性对应的值N
rollup_date汇总日期

true/false。

true :对应 "from_date":"2018-05-29","to_date":"2018-05-30" 时间范围,就是页面缩选时间范围的合计值。
false:对应  "slice_date": "2018-05-29 00:00:00" 某个时间点的值,即页面中,某一个方格中展示的值

默认为 false
slice_date切片时间,即页面中,按 分/小时/天/周/月 查看时,对应的某个切片时间。

取值可以根据 unit 的时间粒度,取值到 分/小时/天/周/月,slice_date 的值,就是对应所选时间所在的 分/小时/天/周/月。

rollup_date 为 false 时,必填
detail是否展示全部用户属性

true/false。

true,则展示全部可见的用户属性。 false,则只展示 id,first_id,second_id。

N,默认是 false
profiles指定展示哪些用户属性用户属性名N ,如果不填这个参数,即detail 为 true,则展示全部可见的用户属性。如果 detail 为 false,则只展示 id。
num_per_page每页展示多少行

参数值自定义

注:仅用于事件分析

N ,默认 30 行
page指定返回第 N 页(从 0 开始)注:仅用于事件分析N

limit

限制返回条数

最大分组个数,如果limit较大(超过1W),建议使用stream模式下载。stream模式开启:添加参数“downloadOriginalFormat” : true。如果不传入该字段,返回的分组数量将根据以下规则计算:10000 / 时间段个数 / 指标个数,时间段个数为 from_date 和 to_date 包含多少个单位为 unit 的时间段,指标个数即 measures 数组个数

注:仅用于事件分析

N,默认最多返回 1 万行
approx 是否近似计算
N
approx_total 合计是否近似计算

使用近似计算合计,当”approx“为 true 时,”approx_total"也设为 true,当“approx”为 false 时,如果“approx_total”为 true,那合计会以近似计算算法得出

N
use_cache  是否使用缓存
N
report_update_time返回结果产生的时间

date_update_time查询涉及事件数据的最后更新时间

date_sufficient_update_time查询涉及事件数据的最后超过1%的更新时间

行为分析报告

所有的分析报告均有 JSON 和 CSV 两种格式,默认是 JSON 格式,如果需要 CSV 格式的数据可以手动指定 format 参数。例如事件分析报告对应的 CSV 格式的 URL 为: /events/report?format=csv 。

事件分析报告

[POST /events/report]

{
"measures":[
{
// 事件名称,特别的,可以使用 $Anything 表示任意事件
"event_name":"$AppClick",
// 聚合操作符
"aggregator":"unique",
//(可选)对于指标的筛选条件
"filter": {
"conditions": [
{
// 指标事件属性
"field": "event.$AppClick.$lib",
// 筛选条件的操作符,equal 这里表示 等于。此处支持多种,如包含等。具体参考文档开头通用参数
"function": "equal",
// 属性的具体值
"params": [
"iOS"
]
}
]
}
}
],
// 起始日期
"from_date":"2021-07-12",
// 结束日期
"to_date":"2021-07-15",
// 时间单位,可以是小时/天/周/月, hour/day/week/month
"unit":"day",
//(可选)筛选条件,全局筛选条件,如果有多指标,该处筛选条件对全部指标有效。
"filter":{
//(可选)筛选条件的关联关系,and 表示'且',or 表示'或'。
"relation":"and",
"conditions":[
{
"field":"event.$AppClick.$country",
"function":"equal",
"params":[
"中国"
]
},
{
"field":"event.$AppClick.$city",
"function":"equal",
"params":[
"北京"
]
}
]
},
//(可选)分组属性,可以有零个或者多个
"by_fields":[
"event.$AppClick.$screen_width",
"event.$AppClick.$screen_height"
],
//(可选)分桶条件,对数值型属性进行分组时,可以自定义分桶条件,如果不设置的话,是默认区间
"bucket_params":{
"event.$AppClick.$screen_width":[100,200],
"event.$AppClick.$screen_height":[1000]
},
// 是否计算合计值
"detail_and_rollup":true,
//(可选)抽样因子,64为全量,32为2分之1抽样
"sampling_factor":64,
//(可选)使用近似计算
"approx":true,
//(可选)基数计算算法hyperloglog的精度,值越大精度越高,但对应内存占用也会变高,推荐用12。
"hll_precision":12,
//(可选)使用近似计算合计,当“approx”为true时,“approx_total”也设为true,当“approx”为false时,如果“approx_total”为true,那合计会以近似计算算法得出
"approx_total":false,
//(可选)最大分组个数
"limit":1000,
//(可选)使用缓存,若缓存中找不到相应数据,则从数据库读出
"use_cache":true
}
{
// 查询所用到的分组属性
"by_fields":[
"event.$Anything.$screen_width",
"event.$Anything.$screen_height"
],
// 查询的时间范围,因为是按天查看,所以会展示每天,如果按周聚合的话,展示的是每周的周一的时间。
"series":[
"2021-07-12 00:00:00",
"2021-07-13 00:00:00",
"2021-07-14 00:00:00",
"2021-07-15 00:00:00"
],
// 查询结果的行数,对应的每行的值,按日期倒叙展示每天的值。
"rows":[
{
// 查询结果,第一行的值[0],[0][1][0],对应[2021-07-15 00:00:00][2021-07-14 00:00:00][2021-07-13 00:00:00][2021-07-12 00:00:00]每天的数据
"values":[
[0],
[0],
[1],
[0]
],
// 查询结果,第一行的属性值"-INF~100","-INF~1000" 表示第一个分组属性的值、第二个分组属性的值。
"by_values":[
"-INF~100",
"-INF~1000"
]
},
{
"values":[
[1],
[0],
[0],
[0]
],
"by_values":[
"-INF~100",
"1000~INF"
]
}
],
// 行数
"num_rows": 2,
// 总行数
"total_rows": 2,
// 全量缓存更新时间
"report_update_time": "2021-07-15 16:51:08.356",
// 查询涉及事件数据的最后更新时间
"data_update_time": "2021-07-15 16:03:32.000",
// 查询涉及事件数据量变化超过 5% 的最后更新时间
"data_sufficient_update_time": "2021-07-15 16:03:32.000",
// 查询是否截断
"truncated": false
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/events/report?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
"measures": [
{
"event_name": "$AppClick",
"aggregator": "unique",
"filter": {
"conditions": [
{
"field": "event.$AppClick.$lib",
"function": "equal",
"params": [
"iOS"
]
}
]
}
}
],
"from_date": "2021-07-12",
"to_date": "2021-07-1502",
"unit": "day",
"filter": {
"relation": "and",
"conditions": [
{
"field": "event.$AppClick.$country",
"function": "equal",
"params": [
"中国"
]
},
{
"field": "event.$AppClick.$city",
"function": "equal",
"params": [
"北京"
]
}
]
},
"by_fields": [
"event.payOrder.$screen_width",
"event.payOrder.$screen_height"
],
"bucket_params": {
"event.payOrder.$screen_width": [
100,
200
],
"event.payOrder.$screen_height": [
1000
]
},
"unit":"day",
"detail_and_rollup": true,
"sampling_factor": 64,
"approx": true,
"hll_precision": 12,
"approx_total": false,
"limit": 1000,
"use_cache": true
}

'


漏斗分析报告

[POST /funnels/report]

{
// 漏斗 ID,如何获取漏斗 ID 可以参见 API 常见问题。 "funnel_id": 158,
// 起始日期 "from_date": "2021-07-15",
// 结束日期 "to_date": "20121-07-18",
  // 筛选条件,具体可见本文 2.2 筛选表达式。 "filter": { "conditions": [ { "field": "event.$AppStart.$lib_version", "function": "contain", "params": [ "0.1.0" ] }, { "field": "event.$AppEnd.$lib", "function": "contain", "params": [ "python" ] }, { "field": "user.Gender", "function": "equal", "params": [ "男" ] } ], "relation": "and" },
// (可选)分组属性,按指定步骤事件属性、用户属性或分群名进行分组 "by_field": "event.$AppStart.$os",
// 是否限制漏斗所有步骤在事件窗口内,true:不限制,false:限制(将首步骤之后的步骤的发生时间限定在时间区间内) "extend_over_end_date": true,
 // (可选)分组的步骤 id,如果为 -1 表示用户属性/分群名,0 表示第一步骤事件属性,
// 若 ”by_field” 中能明确看出为第几步的事件属性/用户属性,则此参数可以不用配置。否则需要配置相应参数值,并且和 ”by_field” 请求参数保持一致 "by_field_step": -1,
//(可选)抽样因子,64为全量,32为2分之1抽样 "sampling_factor": 64,
//(可选)指定筛选条件针对的步骤,0 为第一步骤,-1 为用筛选条件为用户属性/用户分群。
// 在请求参数中 "filter" "conditions"中 “field”中指定了每一步骤的事件名及筛选条件,”filter_field_steps”参数可以不用配置。
// 如果配置此参数,需要和 “field” 请求参数中的步骤保持一致。 "filter_field_steps": [ 0, 1, -1 ] }
{
// 漏斗日期聚合数据列表,有几个日期下面就会有几个 steps。该漏斗结果有 4 个 steps
"date_list": [
"$ALL",
"2021-07-15",
"2021-07-16",
"2021-07-17"
],
// 漏斗转化情况详细信息,按照日期进行详细展示,几个 steps 就代表漏斗按照时间聚合有几个对应的日期+合计。date_list 有几个值就有几个 steps,并且按照 date_list 的顺序展示。
"funnel_detail": [
{
// 每个 steps 包含具体某个日期及日期对应的每个步骤的转化详情(包含人数、转化率、流失人数、转化时间中位数)。
// steps 里包含转化及流失情况。
"steps": [
{
// 漏斗第一步转化详情
"event_name": "ViewHomePage", // 漏斗第一步事件名
"converted_user": 98726, // 漏斗第一步总体人数
"conversion_rate": 100, // 该处为固定值 100
"rows": [
{
// 总体 【合计】 转化详情
"converted_user": 76110, // 第一步总体人数
"conversion_rate": 77.09, // 第一步的转化率
"wastage_user": 22616, // 第一步的流失人数
"median_converted_time": 1505 // 转化时间中位数,单位是秒
},
{
// 具体分组值 【合计】 转化详情
"converted_user": 76110, // 第一步总体人数
"conversion_rate": 77.09, // 第一步的转化率
"wastage_user": 22616, // 第一步流失人数
"median_converted_time": 1505 // 转化时间中位数,单位是秒
}
]
},
{
// 漏斗第二步转化详情,具体参数同上
"event_name": "ViewProduct",
"converted_user": 76110,
"conversion_rate": 77.09,
"rows": [
{
"converted_user": 21266,
"conversion_rate": 27.94,
"wastage_user": 54844,
"median_converted_time": 2530
},
{
"converted_user": 21266,
"conversion_rate": 27.94,
"wastage_user": 54844,
"median_converted_time": 2530
}
]
},
{
// 漏斗第三步转化详情,具体参数同上。
"event_name": "SubmitOrder",
"converted_user": 21266,
"conversion_rate": 27.94,
"rows": [
{
"converted_user": 17522,
"conversion_rate": 82.39,
"wastage_user": 3744,
"median_converted_time": 939
},
{
"converted_user": 17522,
"conversion_rate": 82.39,
"wastage_user": 3744,
"median_converted_time": 939
}
]
},
{
// 漏斗最后一步事件名及转化数据情况
"event_name": "PayOrder",
"converted_user": 17522,
"conversion_rate": 82.39,
"rows": []
}
],
// 漏斗总体转化详情
// 漏斗总体转化率
"completion_rate": 17.75,
// 【总体】具体步骤转化详情,依次是第一步人数、第一步转化情况、第二步转化情况、第三步转化详情
"overview": [
[
{
"converted_user": 98726, // 漏斗第一步总人数
"conversion_rate": 100, // 固定值 100
"completion_rate": 100 // 固定值 100
},
{
"converted_user": 76110, // 漏斗第二步人数
"conversion_rate": 77.09, // 漏斗第一步转化率
"completion_rate": 77.09 // 漏斗第一步流失率
},
{
"converted_user": 21266, // 漏斗第三步人数
"conversion_rate": 27.94, // 漏斗第二步人转化率
"completion_rate": 21.54 // 漏斗第二步流失率
},
{
"converted_user": 17522, // 漏斗第四步人数
"conversion_rate": 82.39, // 漏斗第三步人转化率
"completion_rate": 17.75 // 漏斗第三步流失率
}
],
// 具体分组值【总体】转化步骤详情,依次是第一步人数、第一步转化详情、第二步转化详情、第三步转化详情
[
{
"converted_user": 98726,
"conversion_rate": 100,
"completion_rate": 100
},
{
"converted_user": 76110,
"conversion_rate": 77.09,
"completion_rate": 77.09
},
{
"converted_user": 21266,
"conversion_rate": 27.94,
"completion_rate": 21.54
},
{
"converted_user": 17522,
"conversion_rate": 82.39,
"completion_rate": 17.75
}
]
]
},
// 具体日期对应的具体步骤转化详情,依次是第一步的转化详情、第二步的转化详情、第三步转化详情
{
"steps": [
{
// 具体日期对应的具体步骤转化详情,依次是【总体】里的第一天、具体分组值里的第一天
"event_name": "ViewHomePage", // 第一个事件
"converted_user": 34099, // 第一天第一步人数
"conversion_rate": 100, // 该处固定值 100
"rows": [
{
// 【总体】里第一个日期的转化详情
"converted_user": 26813, // 第一天第一步人数
"conversion_rate": 78.63, // 第一天第一步转化率
"wastage_user": 7286, // 第一天第一步流失人数
"median_converted_time": 1537 // 第一天第一步转化人数中位数
},
{
// 【分组值】里第一个日期的转化详情
"converted_user": 26813,
"conversion_rate": 78.63,
"wastage_user": 7286,
"median_converted_time": 1537
}
]
},
{
"event_name": "ViewProduct",
"converted_user": 26813,
"conversion_rate": 78.63,
"rows": [
{
"converted_user": 7787,
"conversion_rate": 29.04,
"wastage_user": 19026,
"median_converted_time": 2710
},
{
"converted_user": 7787,
"conversion_rate": 29.04,
"wastage_user": 19026,
"median_converted_time": 2710
}
]
},
{
"event_name": "SubmitOrder",
"converted_user": 7787,
"conversion_rate": 29.04,
"rows": [
{
"converted_user": 6449,
"conversion_rate": 82.82,
"wastage_user": 1338,
"median_converted_time": 942
},
{
"converted_user": 6449,
"conversion_rate": 82.82,
"wastage_user": 1338,
"median_converted_time": 942
}
]
},
{
"event_name": "PayOrder",
"converted_user": 6449,
"conversion_rate": 82.82,
"rows": []
}
],
// 具体日期对应的转化详情,依次是【总体】里的某天详情、具体分组里的某天详情
"completion_rate": 18.91,
"overview": [
[
{
"converted_user": 34099,
"conversion_rate": 100,
"completion_rate": 100
},
{
"converted_user": 26813,
"conversion_rate": 78.63,
"completion_rate": 78.63
},
{
"converted_user": 7787,
"conversion_rate": 29.04,
"completion_rate": 22.84
},
{
"converted_user": 6449,
"conversion_rate": 82.82,
"completion_rate": 18.91
}
],
[
{
"converted_user": 34099,
"conversion_rate": 100,
"completion_rate": 100
},
{
"converted_user": 26813,
"conversion_rate": 78.63,
"completion_rate": 78.63
},
{
"converted_user": 7787,
"conversion_rate": 29.04,
"completion_rate": 22.84
},
{
"converted_user": 6449,
"conversion_rate": 82.82,
"completion_rate": 18.91
}
]
]
},
// 具体日期对应的具体步骤转化详情,依次是第一个步的转化详情、第二个步的转化详情、第三步转化详情,具体参数意义同上。
{
"steps": [
{
"event_name": "ViewHomePage",
"converted_user": 34445,
"conversion_rate": 100,
"rows": [
{
"converted_user": 26701,
"conversion_rate": 77.52,
"wastage_user": 7744,
"median_converted_time": 1521
},
{
"converted_user": 26701,
"conversion_rate": 77.52,
"wastage_user": 7744,
"median_converted_time": 1521
}
]
},
{
"event_name": "ViewProduct",
"converted_user": 26701,
"conversion_rate": 77.52,
"rows": [
{
"converted_user": 7407,
"conversion_rate": 27.74,
"wastage_user": 19294,
"median_converted_time": 2594
},
{
"converted_user": 7407,
"conversion_rate": 27.74,
"wastage_user": 19294,
"median_converted_time": 2594
}
]
},
{
"event_name": "SubmitOrder",
"converted_user": 7407,
"conversion_rate": 27.74,
"rows": [
{
"converted_user": 6111,
"conversion_rate": 82.5,
"wastage_user": 1296,
"median_converted_time": 956
},
{
"converted_user": 6111,
"conversion_rate": 82.5,
"wastage_user": 1296,
"median_converted_time": 956
}
]
},
{
"event_name": "PayOrder",
"converted_user": 6111,
"conversion_rate": 82.5,
"rows": []
}
],
"completion_rate": 17.74,
"overview": [
[
{
"converted_user": 34445,
"conversion_rate": 100,
"completion_rate": 100
},
{
"converted_user": 26701,
"conversion_rate": 77.52,
"completion_rate": 77.52
},
{
"converted_user": 7407,
"conversion_rate": 27.74,
"completion_rate": 21.5
},
{
"converted_user": 6111,
"conversion_rate": 82.5,
"completion_rate": 17.74
}
],
[
{
"converted_user": 34445,
"conversion_rate": 100,
"completion_rate": 100
},
{
"converted_user": 26701,
"conversion_rate": 77.52,
"completion_rate": 77.52
},
{
"converted_user": 7407,
"conversion_rate": 27.74,
"completion_rate": 21.5
},
{
"converted_user": 6111,
"conversion_rate": 82.5,
"completion_rate": 17.74
}
]
]
},
// 具体日期对应的具体步骤转化详情,依次是第一步的转化详情、第二步的转化详情、第三步转化详情,具体参数意义同上。
{
"steps": [
{
"event_name": "ViewHomePage",
"converted_user": 33579,
"conversion_rate": 100,
"rows": [
{
"converted_user": 25271,
"conversion_rate": 75.26,
"wastage_user": 8308,
"median_converted_time": 1485
},
{
"converted_user": 25271,
"conversion_rate": 75.26,
"wastage_user": 8308,
"median_converted_time": 1485
}
]
},
{
"event_name": "ViewProduct",
"converted_user": 25271,
"conversion_rate": 75.26,
"rows": [
{
"converted_user": 6845,
"conversion_rate": 27.09,
"wastage_user": 18426,
"median_converted_time": 2469
},
{
"converted_user": 6845,
"conversion_rate": 27.09,
"wastage_user": 18426,
"median_converted_time": 2469
}
]
},
{
"event_name": "SubmitOrder",
"converted_user": 6845,
"conversion_rate": 27.09,
"rows": [
{
"converted_user": 5599,
"conversion_rate": 81.8,
"wastage_user": 1246,
"median_converted_time": 928
},
{
"converted_user": 5599,
"conversion_rate": 81.8,
"wastage_user": 1246,
"median_converted_time": 928
}
]
},
{
"event_name": "PayOrder",
"converted_user": 5599,
"conversion_rate": 81.8,
"rows": []
}
],
"completion_rate": 16.67,
"overview": [
[
{
"converted_user": 33579,
"conversion_rate": 100,
"completion_rate": 100
},
{
"converted_user": 25271,
"conversion_rate": 75.26,
"completion_rate": 75.26
},
{
"converted_user": 6845,
"conversion_rate": 27.09,
"completion_rate": 20.38
},
{
"converted_user": 5599,
"conversion_rate": 81.8,
"completion_rate": 16.67
}
],
[
{
"converted_user": 33579,
"conversion_rate": 100,
"completion_rate": 100
},
{
"converted_user": 25271,
"conversion_rate": 75.26,
"completion_rate": 75.26
},
{
"converted_user": 6845,
"conversion_rate": 27.09,
"completion_rate": 20.38
},
{
"converted_user": 5599,
"conversion_rate": 81.8,
"completion_rate": 16.67
}
]
]
}
],
// 分组
"by_field": "event.$Anything.$os",
// 分组值结果 $ALL 代表整体,iOS 代表分组的具体值
"by_values": [
"$ALL",
"iOS"
],
// 漏斗步骤里对应的事件,依次为第一个事件、第二个事件、第三个事件、第四个事件
"event_names": [
"ViewHomePage",
"ViewProduct",
"SubmitOrder",
"PayOrder"
],
// 全量缓存更新时间
"report_update_time": "2021-07-19 19:13:47.703",
// 查询涉及事件数据的最后更新时间
"data_update_time": "2021-07-19 19:12:56.000",
// 查询涉及事件数据量变化超过 5% 的最后更新时间
"data_sufficient_update_time": "2021-07-19 19:12:56.000",
// 查询是否截断
"truncated": false,
// 抽样系数
"sampling_factor": 64,
"is_done": true
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/funnels/report?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \

--data-binary '

{
  "funnel_id": 158, 
  "from_date": "2021-07-15", 
  "to_date": "20121-07-18", 
  "filter": {
    "conditions": [
      {
        "field": "event.$AppStart.$lib_version", 
        "function": "contain", 
        "params": [
          "0.1.0"
        ]
      }, 
      {
        "field": "event.$AppEnd.$lib", 
        "function": "contain", 
        "params": [
          "python"
        ]
      }, 
      {
        "field": "user.Gender", 
        "function": "equal", 
        "params": [
          "男"
        ]
      }
    ], 
    "relation": "and"
  }, 
  "by_field": "event.$AppStart.$os", 
  "extend_over_end_date": true, 
  "by_field_step": -1, 
  "sampling_factor": 64, 
  "filter_field_steps": [
    0, 
    1, 
    -1
  ]
}

'



 留存分析报告

[POST /retentions/report]

{
// 起始日期
"from_date": "2021-07-19",
// 结束日期
"to_date": "2021-07-20",
// 表示获取往后 N 个单位的留存
"duration": "7",
// 第一个事件的信息
"first_event": {
// 事件名
"event_name": "login"
},
// 第二个事件的信息
"second_event": {
// 事件名
"event_name": "submitOrder",
// 事件的筛选条件
"filter": {
"conditions": [
{
"field": "event.submitOrder.$lib",
"function": "equal",
"params": [
"Android"
]
}
],
"relation":"and"
}
},
// (可选)同时显示第三个指标
"measures": [
{
"event_name": "payOrder",
"aggregator": "unique"
}
],
// (可选)用户的筛选条件
"user_filter": {
"conditions": [
{
"field": "user.sex",
"function": "equal",
"params": [
"男"
]
}
],
"relation":"and"
},
// (可选)时间标识,例如上周,优先级高于 from_date 和 to_date
"rangeText": "上周",
// (可选)留存的单位,可以是 day/week/month
"unit": "day",
// (可选)后续事件是否可以超出时间区间
"extend_over_end_date": true,
// (可选)抽样因子,64为全量,32为2分之1抽样
"sampling_factor": 64,
// (可选)是否计算流失,false为计算留存,true为计算流失
"is_wastage": false,
//(可选)使用缓存,若缓存中找不到相应数据,则从数据库读出
"use_cache": true
}
{
// 表示分组字段值,如果如下为空,代表请求参数里没有选择按照分组查看。
"by_field": "",
"by_fields": [
],
//
"has_first_day": false,
// 查询结果的具体值展示,第一行是总体、第二行开始依次是具体日期的详细数据
"rows": [
{
// 第一行也就是【总体】留存数据详情,$ALL 代表总体。
"by_value": "$ALL",
"by_values": [
"$ALL"
]
,
"total_people": 95, // 初始行为总人数
// cells 里包含的是具体每日的留存数据情况,如果选择了第 0 日,从第 0 日开始依次是第 0 日、第 1 日等每日的留存数据。
"cells": [
{
// 第 0 日的留存数据
"people": 36, // 留存人数
"percent": 37.89, // 留存率
// 选择同时显示后,values 的值即为同时显示的指标的值
"values": [
0
]
},
{
// 第 1 日的留存数据
"people": 6, // 留存人数
"percent": 6.32, // 留存率
// 选择同时显示后,values 的值即为同时显示的指标的值
"values": [
5
]
}
]
},
{
// 第二行的数据也就是【具体日期】留存数据详情,具体参数的含义同上。
"by_value": "2021-07-19",
"by_fields": [
"2021-07-19"
],
"total_people": 91,
"cells": [
{
"people": 25,
"percent": 27.47,
"values": [
0
]
},
{
"people": 1,
"percent": 1.1,
"values": [
1
]
}
]
},
{
"by_value": "2021-07-20",
"by_fields": [
"2021-07-20"
],
"total_people": 62,
"cells": [
{
"people": 25,
"percent": 40.32,
"values": [
0
]
}
]
}
],
// 全量缓存更新时间
"report_update_time": "2021-07-19 17:00:21.355",
// 查询涉及事件数据的最后更新时间
"data_update_time": "2021-07-19 16:59:43.000",
// 查询涉及事件数据量变化超过 5% 的最后更新时间
"data_sufficient_update_time": "2021-07-19 16:59:43.000",
// 查询是否截断
"truncated": false,
// 抽样系数
"sampling_factor": 64,
//
"is_done": true
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/retentions/report?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
"from_date": "2021-07-19",
"to_date": "2021-07-20",
"duration": "7",
"first_event": {
"event_name": "login"
},
"second_event": {
"event_name": "submitOrder",
"filter": {
"conditions": [
{
"field": "event.submitOrder.$lib",
"function": "equal",
"params": [
"Android"
]
}
],
"relation": "and"
}
},
"measures": [
{
"event_name": "payOrder",
"aggregator": "unique"
}
],
"user_filter": {
"conditions": [
{
"field": "user.sex",
"function": "equal",
"params": [
"男"
]
}
],
"relation": "and"
},
"unit": "day",
"extend_over_end_date": true,
"sampling_factor": 64,
"is_wastage": false,
"use_cache": true
}

'

分布分析报告

[POST /addictions/report]

{
// 事件名称
"event_name": "submitOrder",
// 起始时间
"from_date": "2021-07-18",
// 结束时间
"to_date": "2021-07-19",
// 事件筛选条件
"filter": {
"conditions": [
{
"field": "event.submitOrder.$lib",
"function": "equal",
"params": [
"Android"
]
}
],
"relation":"and"
},
// 用户筛选条件
"user_filter": {
"conditions": [
{
"field": "user.sex",
"function": "equal",
"params": [
"男"
]
}
],
"relation":"and"
},
// (可选)时间标识,如:上周,优先级高于from_date、to_date
"rangeText":"上周",
// 抽样因子,64为全量,32为2分之1抽样
"sampling_factor":64,
// 事件单位,可以是 day/week/month
"unit": "day",
// 测量类型,可以是times/period, period是当按小时数或者天数进行分布分析时使用
"measure_type":"times",
//测量类型如果是times,即可以自定义分桶,可省略
"result_bucket_param": [
2,
3
]
}
{
// 表示分组,如果如下“”代表是按照总体查看,没有添加分组查看。
"by_field": "",
// 查询结果的具体值展示,按照日期从小到大依次展示具体日期的详细数据,如 2021-07-18、2021-07-19。
"rows": [
{
// 具体日期的数据分布情况
"by_value": "2021-07-18",
"total_people": 455, // 触发了所分析事件的人数
// cells 里包含的是具体每日的分布数据详情
"cells": [
{
"people": 436, // 该分布区间内人数,如:1~2(不包含 2 )的人数
"percent": 95.82, // 分布区间内人数占总人数比例
"bucket_start": 1, // 分布区间左值
"bucket_end": 2 // 分布区间右值(不包含右值)
},
{
"people": 19, // 该分布区间内人数,如:2~3(不包含 3 )的人数
"percent": 4.18, // 分布区间内人数占总人数比例
"bucket_start": 2, // 分布区间左值
"bucket_end": 3 // 分布区间右值(不包含右值)
}
]
},
{
// 具体日期的数据分布情况,具体参数信息同上
"by_value": "2021-07-19",
"total_people": 280,
"cells": [
{
"people": 273,
"percent": 97.5,
"bucket_start": 1,
"bucket_end": 2
},
{
"people": 7,
"percent": 2.5,
"bucket_start": 2,
"bucket_end": 3
}
]
}
],
// 全量缓存更新时间
"report_update_time": "2021-07-19 17:15:26.739",
// 查询涉及事件数据的最后更新时间
"data_update_time": "2021-07-19 17:14:10.000",
// 查询涉及事件数据量变化超过 5% 的最后更新时间
"data_sufficient_update_time": "2021-07-19 17:14:10.000",
// 查询是否截断
"truncated": false,
// 抽样因子,64为全量,32为2分之1抽样
"sampling_factor": 64,
//
"is_done": true

}

curl 'https://golddemo.cloud.sensorsdata.cn/api/addictions/report?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
"event_name": "submitOrder",
"from_date": "2021-07-18",
"to_date": "2021-07-19",
"filter": {
"conditions": [
{
"field": "event.submitOrder.$lib",
"function": "equal",
"params": [
"Android"
]
}
],
"relation": "and"
},
"user_filter": {
"conditions": [
{
"field": "user.sex",
"function": "equal",
"params": [
"男"
]
}
],
"relation": "and"
},
"sampling_factor": 64,
"unit": "day",
"measure_type": "times",
"result_bucket_param": [
2,
3
]
}

'

用户路径分析报告

[POST /path/analytics/report]

{
// 选择起始事件或者结束事件,起始事件是initial_event, 结束事件是termination_event
"source_type": "initial_event",
// 起始/结束事件及对起始/结束事件的条件筛选过滤
"source_event": {
"event_name": "StartApp", // 起始事件
// 起始事件的筛选条件,筛选条件可以设置多种,可以参考本章 2.2 内容
"filter": {
"conditions": [
{
"field": "event.StartApp.$wifi",
"function": "isTrue",
"params": []
}
]
}
},
// 参与分析的事件
"event_names": [
"BuyBullion",
"BuyGold",
"SaleGold",
"StartApp"
],
// 事件分组,可以按照所选择的参与事件的属性进行分组
"by_fields": [
"event.BuyBullion.$country"
],
// (可选)列数量的限制
"col_limit": 20,
// (可选)每列节点数限制
"row_limit": 7,
// 查询开始时间
"from_date": "2017-05-01",
// 查询结束时间
"to_date": "2017-05-22",
// (可选)用户筛选条件,可选用户属性、用户分群、用户标签作为筛选条件
"user_filter": {},
// (可选)事件分组,所选择分组的事件属性如果是数值型的可以进行自定义分组展示数据,为空的话是默认区间
"bucket_params": {},
// 抽样因子,64为全量,32为2分之1抽样
"sampling_factor": 64,
// session 间隔时间
"session_interval": 1200,
//(可选)使用缓存,若缓存中找不到相应数据,则从数据库读出
"use_cache": true
}
{
// nodes 代表节点,节点里每个大括号里代表一层,如下一共是五层,id 里 0 代表第一层
"nodes": [
// 第一层里数据详情
[
{
"id": "0_StartApp", // 0 代表第一层
"event_name": "StartApp", // 第一层里的事件
"times": 27336 // 会话数
}
],
// 第二层里数据详情,具体参数含义同上,多个 id 代表该层油多个节点
[
{
"id": "1_StartApp",
"event_name": "StartApp",
"times": 163
},
{
"id": "1_BuyGold",
"event_name": "BuyGold",
"times": 118
},
{
"id": "1_SaleGold",
"event_name": "SaleGold",
"times": 104
},
{
"id": "1_BuyBullion_$country_3392903",
"event_name": "BuyBullion",
"times": 37
}
],
// 第三层里数据详情,具体参数含义同上,多个 id 代表该层油多个节点
[
{
"id": "2_SaleGold",
"event_name": "SaleGold",
"times": 68
},
{
"id": "2_BuyGold",
"event_name": "BuyGold",
"times": 50
},
{
"id": "2_BuyBullion_$country_3392903",
"event_name": "BuyBullion",
"times": 18
},
{
"id": "2_StartApp",
"event_name": "StartApp",
"times": 2
}
],
// 第四层里数据详情,具体参数含义同上,多个 id 代表该层油多个节点
[
{
"id": "3_SaleGold",
"event_name": "SaleGold",
"times": 39
},
{
"id": "3_BuyGold",
"event_name": "BuyGold",
"times": 23
},
{
"id": "3_BuyBullion_$country_3392903",
"event_name": "BuyBullion",
"times": 1
}
],
// 第五层里数据详情,具体参数同上
[
{
"id": "4_StartApp",
"event_name": "StartApp",
"times": 1
}
]
],
// 每层数据到下一层的流失、留存详情。每个大括号[] 代表一层,如下以第一层为例
"links": [
[
// 第一层到第二层流失留存详情
{
"source": "0_StartApp", // 第一层事件名
"target": "1_wastage", // 到第二层的状态,wastage 代表是流失
"is_wastage": true, // 是否流失,true 代表是
"times": 26914 // 会话数,该处指流失的会话数
},
{
"source": "0_StartApp", // 第一层事件名
"target": "1_StartApp", // 到第二层对应的事件
"times": 163 // 会话数,该处指留存到第二层的会话数
},
{
"source": "0_StartApp", // 第一层事件名
"target": "1_BuyGold", // 到第二层对应的事件
"times": 118 // 会话数,该处指留存到第二层的会话数
},
{
"source": "0_StartApp", // 第一层事件名
"target": "1_SaleGold", // 到第二层对应的事件
"times": 104 // 会话数,该处指留存到第二层的会话数
},
{
"source": "0_StartApp", // 第一层事件名
"target": "1_BuyBullion_$country_3392903", // 到第二层对应的事件
"times": 37 // 会话数,该处指留存到第二层的会话数
}
],
// 第二层到第三层流失留存详情,具体参数同上
[
{
"source": "1_StartApp",
"target": "2_wastage",
"is_wastage": true,
"times": 160
},
{
"source": "1_StartApp",
"target": "2_StartApp",
"times": 2
},
{
"source": "1_StartApp",
"target": "2_BuyBullion_$country_3392903",
"times": 1
},
{
"source": "1_BuyGold",
"target": "2_wastage",
"is_wastage": true,
"times": 68
},
{
"source": "1_BuyGold",
"target": "2_BuyGold",
"times": 50
},
{
"source": "1_SaleGold",
"target": "2_SaleGold",
"times": 68
},
{
"source": "1_SaleGold",
"target": "2_wastage",
"is_wastage": true,
"times": 36
},
{
"source": "1_BuyBullion_$country_3392903",
"target": "2_wastage",
"is_wastage": true,
"times": 20
},
{
"source": "1_BuyBullion_$country_3392903",
"target": "2_BuyBullion_$country_3392903",
"times": 17
}
],
// 第三层到第四层流失留存详情,具体参数同上
[
{
"source": "2_SaleGold",
"target": "3_SaleGold",
"times": 39
},
{
"source": "2_SaleGold",
"target": "3_wastage",
"is_wastage": true,
"times": 29
},
{
"source": "2_BuyGold",
"target": "3_wastage",
"is_wastage": true,
"times": 27
},
{
"source": "2_BuyGold",
"target": "3_BuyGold",
"times": 23
},
{
"source": "2_BuyBullion_$country_3392903",
"target": "3_wastage",
"is_wastage": true,
"times": 17
},
{
"source": "2_BuyBullion_$country_3392903",
"target": "3_BuyBullion_$country_3392903",
"times": 1
},
{
"source": "2_StartApp",
"target": "3_wastage",
"is_wastage": true,
"times": 2
}
],
// 第四层到第五层流失留存详情,具体参数同上
[
{
"source": "3_SaleGold",
"target": "4_wastage",
"is_wastage": true,
"times": 38
},
{
"source": "3_SaleGold",
"target": "4_StartApp",
"times": 1
},
{
"source": "3_BuyGold",
"target": "4_wastage",
"is_wastage": true,
"times": 23
},
{
"source": "3_BuyBullion_$country_3392903",
"target": "4_wastage",
"is_wastage": true,
"times": 1
}
],
// 第五层到第六层流失留存详情,具体参数同上
[
{
"source": "4_StartApp",
"target": "5_wastage",
"is_wastage": true,
"times": 1
}
]
],
// 用户路径各个列的具体信息
"truncate_row": [],
// 列是否有截断
"truncate_col": false,
// 全量缓存更新时间
"report_update_time": "2021-07-19 17:15:26.739",
// 查询涉及事件数据的最后更新时间
"data_update_time": "2021-07-19 17:14:10.000",
// 查询涉及事件数据量变化超过 5% 的最后更新时间
"data_sufficient_update_time": "2021-07-19 17:14:10.000",
// 查询是否截断
"truncated": false,
// 抽样因子,64为全量,32为2分之1抽样
"sampling_factor": 64,
// 查询是否完成
"is_done": true

}

curl 'https://golddemo.cloud.sensorsdata.cn/api/path/analytics/report?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
"source_type": "initial_event",
"source_event": {
"event_name": "StartApp",
"filter": {
"conditions": [
{
"field": "event.StartApp.$wifi",
"function": "isTrue",
"params": []
}
]
}
},
"event_names": [
"BuyBullion",
"BuyGold",
"SaleGold",
"StartApp"
],
"by_fields": [
"event.BuyBullion.$country"
],
"col_limit": 20,
"row_limit": 7,
"from_date": "2021-07-18",
"to_date": "2021-07-19",
"user_filter": {},
"bucket_params": {},
"sampling_factor": 64,
"session_interval": 1200,
"use_cache": true
}

'

属性分析报告

[POST /user/analytics/report]

{
"measures": [
{
"aggregator": "count",
"field": ""
}
],
"filter": {
"conditions": [
{
"field": "user.vip_level",
"function": "isTrue",
"params": []
}
]
},
// 按照属性进行分组展示,可选用户属性、分群、标签。如下选择了两个用户属性作为分组值
"by_fields": [
"user.IncomeLevel",
"user.Gender"
],
"sampling_factor": null,
// 横轴分组指标
"x_axis_field": "user.IncomeLevel",
"use_cache": false
}
{
// 分组值
"by_fields": [
"user.Gender"
],
// 作为横轴的分组指标值
"series": [
"5000~10000",
"3000~5000",
"10000~20000",
"0~3000",
null
],
// 有几列数据,有几个 by_values 值代表有几列,values 值代表的是每个 series 对应的数据,依次对应如下结果值。
"rows": [
// 具体分组值详细信息
{
// values 值代表的是每个 series 对应的数据,依次对应如下结果值。
"values": [
[
83169
],
[
27776
],
[
55699
],
[
27892
],
[
36106
]
],
// by_values 表示分组值
"by_values": [
"男"
]
},
// 具体分组值详细信息
{
"values": [
[
55363
],
[
18208
],
[
37030
],
[
18668
],
[
24090
]
],
"by_values": [
"女"
]
},
// 具体分组值详细信息
{
"values": [
[
25864
],
[
8490
],
[
17327
],
[
8628
],
[
17353
]
],
"by_values": [
null
]
}
],
// 有几个分组值,也就是有几列数据
"num_rows": 3,
// 全量缓存更新时间
"report_update_time": "2021-07-20 14:16:03.595",
// 查询涉及事件数据的最后更新时间
"data_update_time": "2021-07-20 08:00:00.000",
// 查询涉及事件数据量变化超过 5% 的最后更新时间
"data_sufficient_update_time": "2021-07-20 08:00:00.000"
// 查询是否截断
"truncated": false,
// 抽样因子,64为全量,32为2分之1抽样
"sampling_factor": 64,
//
"is_done": true

}

curl 'https://golddemo.cloud.sensorsdata.cn/api/user/analytics/report?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
"measures": [
{
"aggregator": "count",
"field": ""
}
],
"filter": {
"conditions": [
{
"field": "user.HasByGold",
"function": "isTrue",
"params": []
}
]
},
"by_fields": [
"user.IncomeLevel",
"user.Gender"
],
"sampling_factor": null,
"x_axis_field": "user.IncomeLevel",
"request_id": 1495433768121,
"use_cache": false
}

'

归因分析报告

需要注意的是归因分析报告不支持csv

[POST /attribution/report]

{
// 开始时间
"from_date": "2020-02-01",
// 结束时间
"to_date": "2020-04-15",
// 是否使用缓存
"use_cache": false,
// 直接转化是否参与归因计算
"direct_conversion": true,
// 抽样系数
"sampling_factor": 64,
// 目标事件
"target_event": {
"event_name": "$AppClick",
// 目标事件过滤条件(可选)
"filter": {
"conditions": [
{
// 目标事件属性
"field": "event.$AppClick.$lib",
// 条件的操作符,这里表示等于。支持包含、等于具体使用可以参考:API 通用参数。
"function": "equal",
// 条件的参数,根据不同的操作符可以有一个或者多个。
"params": [
"iOS"
]
}
]

}
},
// 前向事件 可配置多个(可选)
"link_events": [
{
// 前向事件名称
"event_name": "$AppClick",
// 前向事件关联属性
"link_properties": {
// 当前前向事件属性
"current_event_property": "event.$AppClick.$ip",
// 目标事件属性
"target_event_property": "event.$AppClick.$ip"
},
// 前向事件筛选条件
"filter": {}
}
],
// 待归因事件
"attribution_events": {
// 事件集合
"events": [
{
"event_name": "$AppViewScreen"
}
],
// 筛选条件(可选)
"filter": {},
// 分组
"by_fields": [
"event.$Anything.$lib"
]
},
// 筛选条件(可选)
"filter": {
"relation": "and",
"conditions": []
},
// 归因分析模型可选首次触点归因、末次触点归因、线性归因、位置归因、时间衰减归因 ["first","last","linear","position","time_decay"]
"model_type": "first",
// 归因窗口期
"lookback_window": {
// 窗口期单位可选分钟、小时、天 ["minute","hour","day"]
"unit": "day",
"value": 1
}
}
{
"detail_result": {
"rows": [
{
// 没有【待归因事件】 代表【直接转换】,by_values 也会是 null。
"groups": [
{
"by_values": [
null
],
// 待归因事件总点击数
"value": 17,
// 待归因事件转化数量
"converted_number": 17,
// 转化用户数
"converted_user_number": 0,
// 对目标事件的贡献得分
"goal_conversion": 17,
// 对目标事件的贡献度
"conversion_value_rate": 36.96
}
]
},
{
// 待归因事件
"event_name": "$AppViewScreen",
"groups": [
{
"by_values": [
"$iOS"
],
"value": 19,
"converted_number": 13,
"converted_user_number": 1,
"goal_conversion": 29,
"conversion_value_rate": 63.04
}
]
}
]
},
// 全量缓存更新时间
"report_update_time": "2021-07-13 15:16:12.467",
// 查询涉及事件数据的最后更新时间
"data_update_time": "2020-05-10 10:18:48.000",
// 查询涉及事件数据量变化超过 5% 的最后更新时间
"data_sufficient_update_time": "2020-05-10 10:18:48.000",
// 查询是否截断
"truncated": false,
// 抽样因子,64为全量,32为2分之1抽样
"sampling_factor": 64
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/user/analytics/report?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '
{
"from_date": "2020-02-01",
"to_date": "2020-04-15",
"use_cache": false,
"direct_conversion": true,
"sampling_factor": 64,
"target_event": {
"event_name": "$AppClick",
"filter": {
"conditions": [
{
"field": "event.$AppClick.$lib",
"function": "equal",
"params": [
"iOS"
]
}
]

}
},
"link_events": [
{
"event_name": "$AppClick",
"link_properties": {
"current_event_property": "event.$AppClick.$ip",
"target_event_property": "event.$AppClick.$ip"
},
"filter": {}
}
],
"attribution_events": {
"events": [
{
"event_name": "$AppViewScreen"
}
],
"filter": {},
"by_fields": [
"event.$Anything.$lib"
]
},
"filter": {
"relation": "and",
"conditions": []
},
"model_type": "first",
"lookback_window": {
"unit": "day",
"value": 1
}
}

使用curl时需注意 网址是 https 还是 http

用户明细查询

用户明细系列接口用于查询某一个特定分析报告中的具体用户列表,请求的大部分参数与分析报告相同,新增的参数会在每个接口里具体说明。用户列表也支持 JSON 和 CSV 两种格式,默认式 JSON 格式,如果需要 CSV 格式的数据可以手动指定 format 参数。例如事件分析的用户列表对应的 CSV 格式的 URL 为: /events/user/list?format=csv。

事件分析用户明细报告

[POST /events/user/list]

{
"measures": [
{
"aggregator": "unique",
"event_name": "$AppStart",
"name": "App启动的用户数"
}
],
"filter": {
"conditions": [
{
"field": "event.$Anything.$lib",
"function": "equal",
"params": [
"Android"
],
"$$render_index": 1
}
]
},
"by_fields": [
"event.$Anything.$lib"
],
// 查看哪个分组的用户明细
"slice_by_values": [
"Android"
],
// 查询时间范围
"from_date": "2021-07-05",
"to_date": "2021-07-05",
// 汇总日期
"rollup_date": true,
// 时间单位,可以是小时/天/周/月, hour/day/week/month
"unit": "day",
// 指定哪些用户属性,为空表示所有用户属性
"profiles": ["user.$province","user.$signup_time"],

// 是否展示详情,如果 true,则会按照 profile 中的列返回,false 则只返回基本的 id 列
"detail": true,
// 默认值30,表示每页展示用户数,可不加
"num_per_page": 10,
// 请求的页数
"page":1,
// 限制返回的条数
"limit": 100000,
// 是否返回所有用户,如果为 true,则会无视分页参数,否则需要加上分页参数
"all_page": true
}
{
"users": [
{
"id": "1902482830",
"first_id": "23e3ff2a3ff1e1bc",
"second_id": "1696144579",
"profiles": {
"$signup_time": "2021-06-07 15:04:11.999"2,
"Gender": "男"
},
{
"id": "3834577070",
"first_id": "51b0fecc44b5c75b",
"second_id": "1602971488",
"profiles": {
"$signup_time": "2021-06-07 15:04:12.999",
"Gender": "女"
}
}
],
"size": 2,
"page_num": 1, // 页数,总人数/每页展示用户数
"column_name":[
"$signup_time",
"$province"
]
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/events/user/list?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
  "measures": [
    {
      "aggregator": "unique", 
      "event_name": "$AppStart", 
      "name": "App启动的用户数"
    }
  ], 
  "filter": {
    "conditions": [
      {
        "field": "event.$Anything.$lib", 
        "function": "equal", 
        "params": [
          "Android"
        ], 
        "$$render_index": 1
      }
    ]
  }, 
  "by_fields": [
    "event.$Anything.$lib"
  ], 
  "slice_by_values": [
    "Android"
  ], 
  "from_date": "2021-07-05", 
  "to_date": "2021-07-05", 
  "rollup_date": true, 
  "unit": "day", 
  "profiles": [
    "user.$province", 
    "user.$signup_time"
  ], 
  "detail": true, 
  "num_per_page": 10, 
  "page": 1, 
  "limit": 100000, 
  "all_page": true
}

'


漏斗分析用户明细报告

[POST /funnels/user/list]

{
"funnel_id": "4", // 漏斗 ID
// 查询时间范围
"from_date": "2021-06-19",
"to_date": "2021-07-18",
// 筛选条件,示例中筛选条件为
"filter": {
"conditions": [
{
"field": "event.$AppStart.$app_version",
"function": "equal",
"params": [
"2.1"
]
},
{
"field": "event.$AppStart.$lib",
"function": "equal",
"params": [
"Android"
]
}
],
"relation": "and" // 多个筛选条件间的关系
},
// 用户明细的分组信息
"by_fields": ["user.$country"],
// 分层属性值
"slice_by_values": ["$ALL"],
// by_fields 数值的下标值为 index ,by_field_steps[index] 代表第 index 个分组值属于第几个 step
"by_field_steps": ["-1"],
"filter_field_steps": ["0","0"],
// 用户明细的步骤,从 0 开始
"slice_step": 0,
// true 表示查看流失用户明细,false 表示转化用户
"slice_wastage_user": false,
// 指定哪些用户属性,为空表示所有用户属性
"profiles": ["user.$province","user.$signup_time"],
// 是否展示详情,如果 true,则会按照 profile 中的列返回,false 则只返回基本的 id 列
"detail": true,
// 请求的页数
"page":1,
// 每页数据条数
"num_per_page": 30,
// 限制返回的条数
"limit": 100000,
// 是否返回所有用户,如果为 true,则会无视分页参数,否则需要加上分页参数
"all_page": true
}
{
"users": [
{
"id": "1902482830",
"first_id": "23e3ff2a3ff1e1bc",
"second_id": "1696144579",
"profiles": {
"$province": "四川省",
"$signup_time": "2021-06-07 15:04:12.999'
}
},
{
"id": "3834577070",
"first_id": "51b0fecc44b5c75b",
"second_id": "1602971488",
"profiles": {
"$province": "甘肃省",
"$signup_time": "2021-06-07 15:04:11.999"
}
}
],
"size": 2,
"page_num": 1,
"column_name":[
"$signup_time",
"$province"
]
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/funnels/user/list?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
  "funnel_id": "4", 
  "from_date": "2021-06-19", 
  "to_date": "2021-07-18", 
  "filter": {
    "conditions": [
      {
        "field": "event.$AppStart.$app_version", 
        "function": "equal", 
        "params": [
          "2.1"
        ]
      }, 
      {
        "field": "event.$AppStart.$lib", 
        "function": "equal", 
        "params": [
          "Android"
        ]
      }
    ], 
    "relation": "and"
  }, 
  "by_fields": [
    "user.$country"
  ], 
  "slice_by_values": [
    "$ALL"
  ], 
  "by_field_steps": [
    "-1"
  ], 
  "filter_field_steps": [
    "0", 
    "0"
  ], 
  "slice_step": 0, 
  "slice_wastage_user": false, 
  "profiles": [
    "user.$province", 
    "user.$signup_time"
  ], 
  "detail": true, 
  "page": 1, 
  "num_per_page": 30, 
  "limit": 100000, 
  "all_page": true
}

'

留存分析用户明细报告

[POST /retentions/user/list]

{
// 初始行为事件
"first_event": {
"event_name": "$AppViewScreen",
// 初始事件的筛选条件
"filter": {
"conditions": [
{
"field": "event.$AppStart.$app_version",
"function": "equal",
"params": [
"2.1"
]
}
]
}
},
// 后续行为事件
"second_event": {
"event_name": "$AppViewScreen"
},
//是否流失用户,默认留存用户,false 为留存,true 为流失
"is_wastage": false,
// 指定哪些用户属性,为空表示所有用户属性
"profiles": ["user.$province","user.$signup_time"],
// 查询 N 日留存/流失
"duration": 7,
// 查询时间范围
"from_date": "2021-07-05",
"to_date": "2021-07-18",
// 时间单位,可以是小时/天/周/月, hour/day/week/month
"unit": "day",
// 用户明细分的分组值,此示例中是指按初始行为事件的 $app_version 这个事件属性分组,分组值为 2.1
"by_events": ["first"],

"by_field": "event.$AppStart.$app_version",
"slice_by_value": "2.1",
// 查看第几天留存的用户明细,0 表示当天,null 表示全部
// 表示随后第几天留存
"slice_interval": 0,
// 是否展示详情,如果 true,则会按照 profile 中的列返回,false 则只返回基本的 id 列
"detail": true,
// 请求的页数
"page":1,
// 每页数据条数
"num_per_page": 30,
// 限制返回的条数
"limit": 100000,
// 是否返回所有用户,如果为 true,则会无视分页参数,否则需要加上分页参数
"all_page": true
}
{
"users": [
{
"id": "1902482830",
"first_id": "23e3ff2a3ff1e1bc",
"second_id": "1696144579",
"profiles": {
"$province": "四川省",
"$signup_time": "2021-06-07 15:04:12.999"
}
},
{
"id": "3834577070",
"first_id": "51b0fecc44b5c75b",
"second_id": "1602971488",
"profiles": {
"$province": "甘肃省",
"$signup_time": "2021-06-07 15:04:11.999"
}
}
],
"size": 2,
"page_num": 1,
"column_name":[
"$signup_time",
"$province"
]
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/retentions/user/list?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
  "first_event": {
    "event_name": "$AppStart", 
    "filter": {
      "conditions": [
        {
          "field": "event.$AppStart.$app_version", 
          "function": "equal", 
          "params": [
            "2.1"
          ]
        }
      ]
    }
  }, 
  "second_event": {
    "event_name": "$AppViewScreen"
  }, 
  "is_wastage": false, 
  "profiles": [
    "user.$utm_medium", 
    "user.$update_time"
  ], 
  "duration": 7, 
  "from_date": "2021-07-05", 
  "to_date": "2021-07-18", 
  "unit": "day", 
  "by_events": [
    "first"
  ], 
  "by_field": "event.$AppStart.$app_version", 
  "slice_by_value": "2.1", 
  "slice_interval": 0, 
  "detail": true, 
  "page": 1, 
  "num_per_page": 30, 
  "limit": 100000, 
  "all_page": true
}

'

分布分析用户明细报告

[POST /addictions/user/list]

{
"event_name": "$AppStart",
//属性筛选条件,此示例中筛选的事件属性 $app_version = 2.1
"filter": {
"conditions": [
{
"field": "event.$Anything.$app_version",
"function": "equal",
"params": [
"2.1"
]
}
]
},
// 是否合计数据
"rollup_date": false,
// 是否明细数据
"detail": true,
// 查询时间范围
"from_date": "2021-01-20",
"to_date": "2021-07-18",
// 时间单位,可以是小时/天/周/月, hour/day/week/month
"unit": "day",
// 用户明细列表的分组信息,此示例中是按 $app_version 属性分组,分组值为 2.1 的用户列表
"by_field": "event.$Anything.$app_version",
"slice_by_value": "2.1",
// 查看事件触发次数为多少的用户明细列表,此示例中是查询的 $AppStart 事件的触发次数为 2 的
"slice_freq": 2,
// 指定哪些用户属性,为空表示所有用户属性
"profiles":["user.$city","user.$province","user.$signup_time"],
// 请求的页数
"page":0,
// 每页数据条数
"num_per_page": 30,
// 限制返回的条数
"limit": 100000,
// 是否返回所有用户,如果为 true,则会无视分页参数,否则需要加上分页参数
"all_page": true
}
{
"users": [
{
"id": "1902482830",
"first_id": "23e3ff2a3ff1e1bc",
"second_id": "1696144579",
"profiles": {
"$city": "德阳市",
"$province": "四川省",
"$signup_time": "2021-06-07 15:04:12.999"
}
},
{
"id": "3834577070",
"first_id": "51b0fecc44b5c75b",
"second_id": "1602971488",
"profiles": {
"$city": "嘉峪关市",
"$province": "甘肃省",
"$signup_time":"2021-06-07 15:04:11.999"
}
}
],
"size": 2,
"page_num": 0,
"column_name":[
"$signup_time",
"$province"
]
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/addictions/user/list?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
  "event_name": "$AppStart", 
  "filter": {
    "conditions": [
      {
        "field": "event.$Anything.$app_version", 
        "function": "equal", 
        "params": [
          "2.1"
        ]
      }
    ]
  }, 
  "rollup_date": false, 
  "from_date": "2021-01-20", 
  "to_date": "2021-07-18", 
  "unit": "day", 
  "by_field": "event.$Anything.$app_version", 
  "slice_by_value": "2.1", 
  "slice_freq": 2, 
  "profiles": [
    "user.$city", 
    "user.$province", 
    "user.$signup_time"
  ], 
  "page": 0, 
  "num_per_page": 30, 
  "limit": 100000, 
  "all_page": true
}

'

用户列表明细报告

[POST /users/list]

{
"filter": {
"conditions": [
{
// 这里可以任意增加筛选条件
// 可以指定指分群或标签名,如想获取某个分群的用户,则指定 为 'user.fenqun1'
// 也可以指定普通属性名,如 'user.birthday'
// 更多的用法请参考上面的筛选表达式说明
"field": "user.test",
"function": "isTrue"
}
]
},
"profiles": [
// 请求的用户属性列表
"user.$utm_source"
],
// 请求的页数,从 0 开始,0 代表第一页
"page":0,
// 每页数据条数
"num_per_page": 30,
// 限制返回的条数,limit 大于 1W 就会使用功能流输出,无视分页,返回全部数据
"limit": 10000,
// 是否返回所有用户,如果为 true,则会无视分页参数,否则需要加上分页参数
"all_page": true
}
{
"users": [
{
"id": "1902482830",
"first_id": "23e3ff2a3ff1e1bc",
"second_id": "1696144579",
"profiles": {
"FavoriteFruits": [
"Raspberry",
"Orange"
],
"$name": "陈爍簀",
"IncomeLevel": "3000~5000",
"$city": "德阳市",
"$province": "四川省",
"$signup_time": "2021-06-07 15:04:12.999",
"Gender": "男",
"Age": 20.0
}
},
{
"id": "3834577070",
"first_id": "51b0fecc44b5c75b",
"second_id": "1602971488",
"profiles": {
"FavoriteFruits": [
"Cranberry",
"Guava",
"cantaloupe"
],
"$name": "周瀌狙",
"IncomeLevel": "10000~20000",
"$city": "嘉峪关市",
"$province": "甘肃省",
"$signup_time": "2021-06-07 15:04:11.999",
"Gender": "女",
"Age": 20.0
}
}
],
"size": 2,// 每页的数据条数
"page_num": 1,// 请求的页数
//请求的用户属性列表
"column_name":[
"FavoriteFruits",
"$name",
"Age",
"Gender",
"IncomeLevel",
"$signup_time",
"$city",
"$province"
]
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/users/list?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
    "filter":{
        "conditions":[
            {
                "field":"user.test",
                "function":"isTrue"
            }
        ]

    }
,
    "profiles":[
        "user.$utm_source"
    ]
,
    "page":0,
    "num_per_page":30,
    "limit":10000,
    "all_page":true
}

'

这个接口也可以指定要查询的用户id,这样能获取指定用户的属性信息。

{
"filter":{
"conditions":[
{
"field":"user.test",
"function":"isTrue"
}
]
},
"users":["1902482830", "3834577070"],// users参数指定的是神策内部的神策 ID(即 events 表中的 user_id 字段和 users 表中的ID 字段)
"profiles":[
"user.$utm_source"
]
}
{
"users": [
{
"id": "1902482830",
"first_id": "23e3ff2a3ff1e1bc",
"second_id": "1696144579",
"profiles": {
"FavoriteFruits": [
"Raspberry",
"Orange"
],
"$name": "陈爍簀",
"IncomeLevel": "3000~5000",
"$city": "德阳市",
"$province": "四川省",
"$signup_time": "2021-06-07 15:04:12.999",
"Gender": "男",
"Age": 20.0
}
},
{
"id": "3834577070",
"first_id": "51b0fecc44b5c75b",
"second_id": "1602971488",
"profiles": {
"FavoriteFruits": [
"Cranberry",
"Guava",
"cantaloupe"
],
"$name": "周瀌狙",
"IncomeLevel": "10000~20000",
"$city": "嘉峪关市",
"$province": "甘肃省",
"$signup_time": "2021-06-07 15:04:11.999",
"Gender": "女",
"Age": 20.0
}
}
],
"size": 2,// 每页的数据条数
"page_num": 1,// 请求的页数
//请求的用户属性列表

"column_name":[
"FavoriteFruits",
"$name",
"Age",
"Gender",
"IncomeLevel",
"$signup_time",
"$city",
"$province"
]
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/users/list?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
"filter":{
"conditions":[
{
"field":"user.test",
"function":"isTrue"
}
]
},
"users":["1902482830", "3834577070"],
"profiles":[
"user.$utm_source"
]
}

'

用户路径用户明细报告

[POST /users/list]

{
// 当前节点信息
"slice_element_filter": [
{
"slice_event_name": "AppInstall",// 当前节点事件
"slice_by_value": "Android" // 当前节点分组属性值
}
],
// 后续节点信息
"next_slice_element_filter": [
{
"slice_event_name": "AppInstall",// 后续节点事件
"slice_by_value": "Android" // 后续节点分组属性值
}
], // 合计,后续事件统计和流失不需要这个过滤条件
"session_level": "0", // 当前节点在第几层 从0 开始
"source_type": "initial_event",// 说明是起始事件
// 起始事件信息

"source_event": {
"event_name": "AppInstall",
"filter": {
"conditions": [
{
"field": "event.AppInstall.$wifi",
"function": "isTrue"
}
]
}
},
// 参与分析的事件
"event_names": [
"$AppClick",
"AppInstall",
"$AppStart"
],
// 按照属性进行分组展示
"by_fields":["event.$AppStart.$lib"],
// 指定哪些用户属性,为空表示所有用户属性
"profiles":["user.$province","user.$signup_time"],

"session_interval": "1200",
// 查询时间范围
"from_date": "2021-02-01",
"to_date": "2021-07-19",
// 是否展示详情,如果 true,则会按照 profile 中的列返回,false 则只返回基本的 id 列
"detail": true,
"col_limit": "20", // 最多支持多少行
"row_limit": "7", // 最多支持多少列
"sampling_factor": 64, //(可选)抽样因子,64为全量,32为2分之1抽样
"is_aggregate": "false", // 当前节点是否表示更多
"edge_type": "ALL", // 可以是WASTAGE,RETENTION和ALL,分别表示流失节点,后续事件统计,该节点合计人数
"is_next_aggregate": "false", // 后续节点是否表示更多
"num_per_page": 50, // 每页数据条数
"all_page": true, // 是否返回所有用户
"limit": 1000, // 限制返回条数
"filter": {},
"use_cache": false // 是否使用缓存
}
{
"users": [
{
"id": "1902482830",
"first_id": "23e3ff2a3ff1e1bc",
"second_id": "1696144579",
"profiles": {
"$province": "四川省",
"$signup_time": "2021-03-17 14:58:00"
}
},
{
"id": "3834577070",
"first_id": "51b0fecc44b5c75b",
"second_id": "1602971488",
"profiles": {
"$province": "甘肃省",
"$signup_time": "2021-03-19 14:58:00"
}
}
],
"size": 2,
"page_num": 1,
"column_name":[
"$signup_time",
"$province"
]
}

curl 'https://golddemo.cloud.sensorsdata.cn/api/users/list?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
  "slice_element_filter": [
    {
      "slice_event_name": "AppInstall", 
      "slice_by_value": null
    }
  ], 
  "next_slice_element_filter": [
    {
      "slice_event_name": "AppInstall", 
      "slice_by_value": "1"
    }
  ], 
  "session_level": "0", 
  "source_type": "initial_event", 
  "source_event": {
    "event_name": "AppInstall", 
    "filter": {
      "conditions": [
        {
          "field": "event.AppInstall.$wifi", 
          "function": "isTrue"
        }
      ]
    }
  }, 
  "event_names": [
    "$AppClick", 
    "AppInstall", 
    "$AppStart"
  ], 
  "profiles": [
    "user.$province", 
    "user.$signup_time"
  ], 
  "session_interval": "1200", 
  "from_date": "2021-02-01", 
  "to_date": "2021-07-19", 
  "detail": true, 
  "col_limit": "20", 
  "row_limit": "7", 
  "sampling_factor": 64, 
  "is_aggregate": "false", 
  "edge_type": "ALL", 
  "is_next_aggregate": "false", 
  "num_per_page": 50, 
  "all_page": true, 
  "limit": 1000, 
  "filter": { }, 
  "use_cache": false
}

'

自定义查询和用户行为列表

自定义查询

[POST /sql/query]

通过 SQL 进行自定义查询,表结构及自定义查询方法详见 自定义查询 功能的介绍。

注意:(1)如果查询的事件是预置事件,那么 $ 符号需要使用 \ 进行转义。

           (2)如果是导出 items 表中的数据,需要保证神策系统版本为 1.15.1646 及之后的版本。

  • Parameters
  • q: 查询的 SQL,例如 SELECT event,time,user_id FROM events LIMIT 10
  • format: 可能的值包括
    • csv:默认格式
    • json:每行一个 JSON
    • event_json:导出可以用于直接导入的 Event Track 格式的 Json,1.15 及之后的版本支持,且不支持使用别名(select $utm_source as utm_source ……)
    • profile_json:导出可以用于直接导入的 Profile Set/Track Signup 格式的 Json,1.15 及之后的版本支持,且不支持使用别名(select $utm_source as utm_source ……)
    • item_json: 导出可以用户直接导入神策系统的 item_set 格式的 Json,1.15.1646 及之后的版本才支,且不支持使用别名(select $utm_source as utm_source ……)
    • sql:不直接返回数据,而是翻译为一条可以直接在 Spark/Impala/Hive 里执行的 SQL

q=SELECT * FROM events LIMIT 10

format=json

{"date":"2021-02-01","$utm_medium":"媒介4","$viewport_position":620,"$is_first_time":1,"$ip":"127.0.0.1","$utm_term":"广告词2","$referrer":"referrer2","$viewport_height":1129,"$url_path":"path2","$url":"url2","$share_depth":524,"event":"$pageview","$element_content":"产品概览","$receive_time":1615963982244,"$referrer_host":"host3","$viewport_width":732,"$utm_source":"B站","$lib":"Java","$event_duration":585,"$utm_campaign":"广告3","user_id":-8777352483108746240,"distinct_id":"TcRljcpRJshin2pf","$title":"标题3","$utm_content":"内容1","time":"2021-02-01 10:24:20.149","$resume_from_background":1}
{"date":"2021-02-01","$utm_medium":"媒介2","$viewport_position":690,"$is_first_time":1,"$ip":"127.0.0.1","$utm_term":"广告词4","$referrer":"referrer1","$viewport_height":737,"$url_path":"path1","$url":"url1","$share_depth":1141,"event":"$pageview","$element_content":"在线销售","$receive_time":1615963985088,"$referrer_host":"host3","$viewport_width":847,"$utm_source":"B站","$lib":"Java","$event_duration":152,"$utm_campaign":"广告4","user_id":-775465369173725182,"distinct_id":"23iTvnZ1fEcDkG43","$title":"标题3","$utm_content":"内容1","time":"2021-02-01 13:06:41.599","$resume_from_background":1}
{"date":"2021-02-01","$utm_medium":"媒介4","$viewport_position":1197,"$is_first_time":0,"$ip":"127.0.0.1","$utm_term":"广告词4","$referrer":"referrer1","$viewport_height":708,"$url_path":"path2","$url":"url3","$share_depth":883,"event":"$pageview","$element_content":"道路救援","$receive_time":1615963985506,"$referrer_host":"host3","$viewport_width":46,"$utm_source":"头条","$lib":"Java","$event_duration":540,"$utm_campaign":"广告4","user_id":-1032801030870320381,"distinct_id":"EmFSBmTmYbXUpJOu","$title":"标题1","$utm_content":"内容1","time":"2021-02-01 06:16:29.406","$resume_from_background":1}

该接口和其它 API 的调用方式有所不同,q 参数直接用 GET/POST 参数传递即可,csv 格式返回的数据为 \t 分隔。一个使用 curl 的例子如下:

curl 'https://saasdemo.cloud.sensorsdata.cn/api/sql/query?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \

-X POST \

--data-urlencode "q=SELECT * FROM events LIMIT 10" \

--data-urlencode "format=csv"


用户行为列表

[POST /users/event/list]

获取一个或者多个用户在某一段时间内的详细行为信息。

{
// 需要查询行为序列的用户的 ID
"users": [ "111", "73e51c75edc00593" ], "from_date": "2021-06-04", "to_date": "2021-06-04",
// false 表示 users参数指定的是神策内部的神策 ID(即 events 表中的 user_id 字段和 users 表中的ID 字段);true 表示传入的是 distinct_id
"distinct_id": true }
{
// 用户行为序列中的事件及事件属性 "events": [ { "distinct_id": "111", "user_id": "91956876552221643", "event": "$AppStart", "time": "2021-06-04 11:52:19.091", "properties": { "$ip": "10.90.28.102", "$lib": "Android", "$track_signup_original_id": "73e51c75edc00593", "$country": "保留IP", "$screen_width": 1080, "$screen_orientation": "portrait", "$screen_height": 2340, "$app_name": "Market", "$app_id": "com.sqh.market", "$app_version": "1.0.1", "$os": "Android", "$os_version": "10", "$timezone_offset": -480, "$wifi": 0, "$resume_from_background": 0, "$is_first_day": 0, "$is_first_time": 0, "$province": "保留IP", "$city": "保留IP", "$latitude": 3000000, "$longitude": 4000000, "$network_type": "NULL", "$device_id": "73e51c75edc00593", "$manufacturer": "HUAWEI", "$model": "EBG-AN00", "$carrier": "中国联通", "$screen_name": "com.sqh.market.activity.AnimationActivity", "$title": "Market" }, "profiles": null }, { "distinct_id": "111", "user_id": "91956876552221643", "event": "$AppStart", "time": "2021-06-04 15:54:16.529", "properties": { "$ip": "10.90.28.102", "$lib": "Android", "$track_signup_original_id": "73e51c75edc00593", "$country": "保留IP", "$screen_width": 1080, "$screen_orientation": "portrait", "$screen_height": 2340, "$app_name": "Market", "$app_id": "com.sqh.market", "$app_version": "1.0.1", "$os": "Android", "$os_version": "10", "$timezone_offset": -480, "$wifi": 1, "$resume_from_background": 0, "$is_first_day": 0, "$is_first_time": 0, "$province": "保留IP", "$city": "保留IP", "$latitude": 3000000, "$longitude": 4000000, "$network_type": "WIFI", "$device_id": "73e51c75edc00593", "$manufacturer": "HUAWEI", "$model": "EBG-AN00", "$carrier": "中国联通", "$screen_name": "com.sqh.market.activity.AnimationActivity", "$title": "Market" }, "profiles": null } ] }

curl 'https://golddemo.cloud.sensorsdata.cn/api/users/event/list?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d&project=default' \
-H 'Content-Type: application/json' \
--data-binary '

{
  "users": [
    "111", 
    "73e51c75edc00593"
  ], 
  "from_date": "2021-06-04", 
  "to_date": "2021-06-04", 
  "distinct_id": true
}
'

常见问题

查询 API 提示 {"error":"没有访问权限,请检查 project 和 token"} ?

首先:检查下请求地址中的域名是不是客户系统自己神策分析页面环境登录系统的域名(注意:不是数据接收地址的域名哦
其次:检查 project 和 token 是不是同一个项目的参数
最后:检查 token 是 admin 账号下的 API Secret 还是通过自己的账号密码获取的 Access token。如果是 API Secret ,token 直接放在 url 链接后面。如果是 Access token ,token 参数不能直接放在 url 链接后面 ,需要放在 Header 参数中,即添加参数:
-H 'sensorsdata-token: {获取的 Access token}'
具体可参考此文档:API 请求地址说明

查询引擎错误

可以检查下查询的 API 接口和参数名是否对应,以及设置的参数格式是否正确。

报错API return 422

API SQL 查询时,$ 符号需要转译

API 查询或者下载用户列表等使用后台分析服务时,504报错

服务转发配置没有配置连接超时时间或者超时时间设置较短,让客户修改超时时间即可。一般我们建议数据接收地址超时时间为 60 ,后台分析服务超时时间为 1800。

是否可以使用查询 API 将查询结果返回到客户线上的业务用于实时分析?查询 API 的请求频次有什么限制?

神策查询 API 只适合低频调用,相应速度取决如下两方面:

  1. 实际的查询场景:如数据量、查询数据的时间范围、所用的分析模型或 SQL 的复杂度等;
  2. 硬件和网络配置:如 CPU、内存、网卡、硬盘等

在查询场景和神策服务器配置匹配的前提下,神策建议 API 调用频率保持在分钟级,单次查询的数据范围在 1 万条以内,同一时间最大并发请求量不超过 10 个,以确保查询相应和神策服务性能稳定。如条件超出如上描述范围,可能出现无法响应/查询慢/甚至神策服务性能不稳定情况。
如上为神策根据历史对接经验给出,考虑到不同客户查询调用的场景各有差异,建议以实测为准,根据实际测试结果合理调整查询条件和调用频次。

如何获取漏斗 ID?

可以使用 获取漏斗列表的 API  [GET  /funnels?limit=1000获取所有漏斗信息,然后再返回结果里获取漏斗 ID。注意,必须要带有 limit 参数

[
  {
    "update_time": "2018-01-18 11:35:00", 
    "access": true, 
    "create_time": "2018-01-18 10:07:17", 
    "user_name": "admin", 
    "step_name": [
      "APP启动", 
      "绑定银行卡", 
      "绑定银行卡成功", 
      "点击投资", 
      "提交投资项目", 
      "投资成功"
    ], 
    "name": "投资成功留存率-设置筛选条件", 
    "id": 5, // 漏斗 ID
    "max_convert_time": 10080
  }
]