目录
此内容是否有帮助?

# 路径分析模型 API

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

可阅读使用手册中 路径分析 了解使用场景。

# 路径分析查询

接口 URL

/open/path-analyze?token=xxx

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥

# 请求 Body 参数

{
  "eventView": {
    "col_limit": 10,
    "from_date": "2021-10-01 00:00:00",
    "recent_day": "",
    "session_interval": 30,
    "session_type": "minute",
    "to_date": "2021-10-02 23:59:59"
  },
  "events": {
    "by_fields": [
      {
        "event_name": "login",
        "field": "browser",
        "range": "",
        "table_type": "event"
      }],
    "event_names": [
      "logout",
      "login"],
    "source_event": {
      "event_name": "login",
      "filter": {
        "filterType": "COMPOUND"
      }
    },
    "source_type": "initial_event",
    "user_filter": {
      "filterType": "COMPOUND",
      "filts": [
        {
          "columnDesc": "城市",
          "columnName": "city",
          "comparator": "equal",
          "filterType": "SIMPLE",
          "ftv": [
            "北京市",
            "上海市",
            "广州市",
            "深圳市"],
          "specifiedClusterDate": "2022-01-24",
          "tableType": "user"
        }],
      "relation": "and"
    }
  },
  "projectId": 377,
  "timeoutSeconds": 10,
  "useCache": true
}

# 请求参数说明

参数名 示例值 参数类型 是否必填 参数描述
eventView
-
Object

分组属性
col_limit 10
Integer

列限制,0到20之间
from_date 2021-10-01 00:00:00
String

开始时间 yyyy-MM-dd HH:mm:ss
recent_day String

相对时间
session_interval 30
Integer

会话间隔时长
session_type minute
String

会话间隔时长单位: second, minute, hour
to_date 2021-10-02 23:59:59
String

结束时间 yyyy-MM-dd HH:mm:ss
events
-
List

事件指标列表
by_fields -
List
List
按事件属性拆分
event_name login
String

事件名
field browser
String

拆分字段
range_type -
String

区间间隔类型
discrete:离散数字
def:默认区间
user_defined:用户自定义
range -
String

区间
table_type event
String

表类型,event:事件表,user:用户表
event_names ["logout","login"]
String

事件名称,特别的,可以使用 anyEvent 表示任意事件
source_event -
Object

源事件
event_name login
String

事件名
filter -
Object

源事件过滤
filterType COMPOUND
String

过滤模式,SIMPLE:简单,COMPOUND:复合
source_type initial_event
String

事件类型,initial_event,termination_event
user_filter -
Object

用户表过滤
filterType COMPOUND
String

过滤模式,SIMPLE:简单,COMPOUND:复合
filts -
List

条件列表列表
columnDesc app_version
String

字段显示名
columnName app_version
String

字段名称
comparator equal
String

参考: 模型查询API的筛选表达式
filterType SIMPLE
String

过滤模式,SIMPLE:简单,COMPOUND:复合
ftv ["V1.0"]
List

用于属性比较边界的字面常量
specifiedClusterDate 2022-01-26
String

指定对应日期的标签历史版本
tableType event
String

表类型,event:事件表,user:用户表
relation and
String

逻辑关系,and:逻辑与,or:逻辑或
projectId
377
Integer

项目ID
timeoutSeconds
10
Integer

请求超时参数,超时则取消查询任务
useCache
true
Boolean

使用缓存,可选参数,默认为true

# 成功响应示例

{
  "data": {
    "event_name_desc_map": {
      "anyEvent": "任意事件",
      "login": "登录",
      "logout": "用户登出"
    },
    "links": [
      [
        {
          "source": "0_Chrome^_^login",
          "target": "1_logout",
          "times": 1716
        },
        {
          "source": "0_Safari^_^login",
          "target": "1_logout",
          "times": 765
        },
        {
          "source": "0_Firefox^_^login",
          "target": "1_logout",
          "times": 582
        },
        {
          "source": "0_微信内置浏览器^_^login",
          "target": "1_logout",
          "times": 403
        },
        {
          "is_wastage": true,
          "source": "0_Chrome^_^login",
          "target": "1_wastage",
          "times": 380
        },
        {
          "is_wastage": true,
          "source": "0_Safari^_^login",
          "target": "1_wastage",
          "times": 195
        },
        {
          "is_wastage": true,
          "source": "0_Firefox^_^login",
          "target": "1_wastage",
          "times": 148
        },
        {
          "is_wastage": true,
          "source": "0_微信内置浏览器^_^login",
          "target": "1_wastage",
          "times": 89
        }
      ]
    ],
    "nodes": [
      [
        {
          "by_value": "Chrome",
          "event_name": "login",
          "id": "0_Chrome^_^login",
          "times": 2096
        },
        {
          "by_value": "Safari",
          "event_name": "login",
          "id": "0_Safari^_^login",
          "times": 960
        },
        {
          "by_value": "Firefox",
          "event_name": "login",
          "id": "0_Firefox^_^login",
          "times": 730
        },
        {
          "by_value": "微信内置浏览器",
          "event_name": "login",
          "id": "0_微信内置浏览器^_^login",
          "times": 492
        }
      ],
      [
        {
          "event_name": "logout",
          "id": "1_logout",
          "times": 3466
        }
      ]
    ],
    "result_generate_time": "2022-01-27 13:44:38"
  },
  "return_code": 0,
  "return_message": "success"
}

# 响应参数说明

参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息
data
-
Object
返回数据
event_name_desc_map -
Map
事件名和事件描述映射
links -
List
关系矩阵
source 0_Chrome^_^login
String
关系开始节点
target 1_level_up
String
关系结束节点
times 5106
Integer
次数
nodes -
List
节点矩阵
id 0_Chrome^_^login
String
节点ID
event_name login
String
节点事件名
by_value Chrome
String
节点值
times 30301
Integer
次数
result_generate_time 2022-01-24 18:53:26
String
查询结果生成时间

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名 示例值 参数类型 参数描述
return_code
-1008
Integer
返回码
return_message
参数(token)为空
String
返回信息

# 路径分析用户列表

接口 URL

/open/path-user-list?token=xxx

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥

# 请求 Body 参数

{
  "projectId": 0,
  "eventView": {
    "col_limit": 10,
    "from_date": "2019-11-20 00:00:00",
    "to_date": "2019-11-26 00:00:00",
    "recent_day": "1-7",
    "session_interval": 22,
    "session_type": "minute"
  },
  "events": {
    "event_names": [
      "obtain_item",
      "consume_item",
      "obtain_coin"
    ],
    "source_event": {
      "event_name": "consume_item",
      "filter": {
        "filts": [
          {
            "columnName": "#os",
            "comparator": "equal",
            "ftv": [
              "ios"
            ],
            "tableType": "event"
          }
        ],
        "relation": "and"
      }
    },
    "source_type": "initial_event",
    "user_filter": {
      "filts": [
        {
          "columnName": "user_level",
          "comparator": "equal",
          "ftv": [
            "6"
          ],
          "tableType": "user"
        }
      ],
      "relation": "and"
    }
  },
  "next_slice_event_by_values": [
    {
      "slice_event_name": "obtain_coin"
    }
  ],
  "session_level": 2,
  "slice_type": "with_next_specific",
  "slice_event_by_values": [
    {
      "slice_event_name": "obtain_item"
    }
  ],
  "timeoutSeconds": 10
}

# 请求参数说明

参数名 示例值 参数类型 是否必填 参数描述
projectId
0
String

参数描述
eventView
-
Object

分组属性表
events
List

事件指标列表
next_slice_event_by_values
-
List

节点的后续事件
slice_type=with_next_specific时必填
slice_event_name obtain_coin
String

事件名称
session_level
2
Integer

节点所处的路径层级(从0开始计数)
slice_type
with_next_specific
String

节点的后续事件情况
total:合计
with_next:后续有节点
without_next:后续没有节点
with_next_specific:后续有某个事件的节点
slice_event_by_values
-
List

节点事件
slice_event_name obtain_item
String

事件名称
timeoutSeconds
10
Integer

请求超时参数,超时则取消查询任务

# 成功响应示例

{
  "data": {
    "datalist": [
      {
        "#account_id": "j77444535",
        "#distinct_id": "j143825535",
        "user_level": 6,
        "register_time": "2019-11-22 17:07:12",
        "diamond_num": 1270,
        "latest_login_time": "2019-11-22 18:23:19",
        "channel": "app store",
        "#user_id": 33190535
      }
    ],
    "total_num": 1,
    "columMeta": {
      "#account_id": "账户ID",
      "#distinct_id": "访客ID",
      "user_level": "用户等级",
      "register_time": "注册时间",
      "diamond_num": "当前拥有钻石数",
      "first_recharge_time": "首次充值时间",
      "latest_login_time": "最后登录时间",
      "channel": "渠道"
    }
  },
  "return_code": 0,
  "return_message": "success"
}

# 响应参数说明

参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息
data
-
Object
返回结果
datalist -
List
用户信息
columMeta -
Map
字段含义映射

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名 示例值 参数类型 参数描述
return_code
-1008
Integer
返回码
return_message
参数(token)为空
String
返回信息