# 経路解析モデル API
呼び出し方法Open APIドキュメントの呼び出し方法の説明を参照してください。
使用マニュアルの経路分析使用シーンを知ることができる。
# パス分析クエリ
インターフェイス URL
/open/path-analyze?token=xxx
リクエスト方法
POST
コンテンツタイプ
application/json
Query パラメーター
パラメータ名 | サンプル値 | パラメーターの種類 | 必須かどうか | パラメーターの説明 |
---|---|---|---|---|
token | xxx | String | はい | token |
# 要求 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 | 一覧 | イベント属性で分割 |
∟ event_name | login | String | はい | イベント名 |
∟ field | browser | String | はい | 分割フィールド |
∟ 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",
"showStackMessage": false
}
# 応答パラメータ説明
パラメーター名 | サンプル値 | パラメーターの種類 | パラメーターの説明 |
---|---|---|---|
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
コンテンツタイプ
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 | はい | グループ化属性テーブル |
∟ col_limit | 10 | String | はい | 0から20の間 |
∟ from_date | 2019-11-20 00:00:00 | String | いいえ | 開始時刻(形式: yyyy-MM-ddHH: mm: ss) |
∟ to_date | 2019-11-26 00:00:00 | String | いいえ | 終了時刻(形式: yyyy-MM-ddHH: mm: ss) |
∟ recent_day | 1-7 | String | いいえ | 相対時間(開始時刻と終了時刻の両方で空であってはならない) |
∟ session_interval | 22 | Integer | はい | セッション間隔の長さ |
∟ session_type | minute | String | はい | セッション間隔の長さ単位: second, minute, hour |
events | List | はい | イベントインジケータ一覧 | |
∟ event_names | ["obtain_item"] | List | はい | イベント名、特別な、任意のイベントを表すためにanyEventを使用できます |
∟ source_event | - | Object | はい | 開始イベント |
∟ event_name | consume_item | String | はい | イベント名は、最大30件 |
∟ filter | - | Object | いいえ | フィルター |
∟ filts | - | List | いいえ | フィルタ項目一覧 |
∟ columnName | #os | String | はい | フィールド名 |
∟ comparator | equal | String | はい | 参照:モデルクエリAPIのフィルター式 |
∟ ftv | ["ios"] | List | いいえ | プロパティの比較値 |
∟ tableType | event | String | はい | テーブルタイプ、event:イベントテーブル、user:ユーザテーブル |
∟ relation | and | String | いいえ | 論理関係、and:論理と、or:論理や |
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 | はい | ノードの後続イベントの状況 合計:合計 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 | 戻る情報 |