跳到主要内容

路径分析模型 API

最近更新 2026/10/05

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

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

1. 路径分析查询​

接口URL

/open/path-analyze?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求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,
  "zoneOffset": 10
}

请求参数说明​

$$参数名示例值参数类型是否必填参数描述
eventView-Object是指标公共属性部分
eventView.col_limit10Integer是列限制，0到20之间
eventView.from_date2021-10-01 00:00:00String否开始时间 yyyy-MM-dd HH:mm:ss
eventView.recent_dayString否相对时间
eventView.session_interval30Integer是会话间隔时长
eventView.session_typeminuteString是会话间隔时长单位: second, minute, hour
eventView.to_date2021-10-02 23:59:59String否结束时间 yyyy-MM-dd HH:mm:ss
events-List是事件指标列表
events.by_fields-ListList按事件属性拆分
events.by_fields.event_nameloginString是事件名
events.by_fields.fieldbrowserString是拆分字段
events.by_fields.range_type-String否

区间间隔类型

  • discrete：离散数字
  • def：默认区间
  • user_defined：用户自定义
events.by_fields.range-String否区间
events.by_fields.table_typeeventString是表类型，event：事件表，user：用户表
events.event_names["logout","login"]String是事件名称，特别的，可以使用 anyEvent 表示任意事件
events.source_event-Object是源事件
events.source_event.event_nameloginString是事件名
events.source_event.filter-Object否源事件过滤
events.source_event.filter.filterTypeCOMPOUNDString否过滤模式，SIMPLE：简单，COMPOUND：复合
events.source_typeinitial_eventString是事件类型，initial_event，termination_event
events.user_filter-Object否用户表过滤
events.user_filter.filterTypeCOMPOUNDString否过滤模式，SIMPLE：简单，COMPOUND：复合
events.user_filter.filts-List否条件列表列表
events.user_filter.filts.columnDescapp_versionString否字段显示名
events.user_filter.filts.columnNameapp_versionString是字段名称
events.user_filter.filts.comparatorequalString是参考： 模型查询API的筛选表达式
events.user_filter.filts.filterTypeSIMPLEString否过滤模式，SIMPLE：简单，COMPOUND：复合
events.user_filter.filts.ftv["V1.0"]List否用于属性比较边界的字面常量
events.user_filter.filts.specifiedClusterDate2022-01-26String否指定对应日期的标签历史版本
events.user_filter.filts.tableTypeeventString是表类型，event：事件表，user：用户表
events.user_filter.relationandString否逻辑关系，and：逻辑与，or：逻辑或
projectId377Integer是项目ID
timeoutSeconds10Integer否请求超时参数，超时则取消查询任务
useCachetrueBoolean是true为使用缓存
zoneOffset10Integer否时区

成功响应示例​

{
  "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_code0Integer返回码
return_messagesuccessString返回信息
data-Object返回数据
data.event_name_desc_map-Map事件名和事件描述映射
data.links-List<List>关系矩阵
data.links.source0_Chrome^_^loginString关系开始节点
data.links.target1_level_upString关系结束节点
data.links.times5106Integer次数
data.nodes-List<List>节点矩阵
data.nodes.id0_Chrome^_^loginString节点ID
data.nodes.event_nameloginString节点事件名
data.nodes.by_valueChromeString节点值
data.nodes.times30301Integer次数
data.result_generate_time2022-01-24 18:53:26String查询结果生成时间

错误响应示例

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

2. 路径分析用户列表​

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求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,
  "zoneOffset": 10
}

请求参数说明​

$$参数名示例值参数类型是否必填参数描述
projectId0String是参数描述
eventView-Object是参数内容与路径分析查询接口一致
eventsList是事件指标列表
next_slice_event_by_values-List否

节点的后续事件

slice_type=with_next_specific时必填

next_slice_event_by_values.slice_event_nameobtain_coinString否事件名称
session_level2Integer是节点所处的路径层级（从0开始计数）
slice_typewith_next_specificString是

节点的后续事件情况

  • total：合计
  • with_next：后续有节点
  • without_next：后续没有节点
  • with_next_specific：后续有某个事件的节点
slice_event_by_values-List否节点事件
slice_event_by_values.slice_event_nameobtain_itemString否事件名称
timeoutSeconds10Integer否请求超时参数，超时则取消查询任务
zoneOffset10Integer否时区

成功响应示例​

{
  "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_code0Integer返回码
return_messagesuccessString返回信息
data-Object返回结果
data.datalist-List<Map>用户信息
data.columMeta-Map字段含义映射

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名示例值参数类型参数描述
return_code-1008Integer返回码
return_message参数(token)为空String返回信息
这篇文档对你有帮助吗？
本页内容