目录
此内容是否有帮助?

# ファネル解析モデル API

呼び出し方法Open APIドキュメントの呼び出し方法の説明を参照してください。

使用マニュアルで漏斗分析使用シーンを知ることができる。

# ファネル分析クエリ

インターフェイス URL

/open/funnel-analyze?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String

トークン

# 要求 Body パラメーター

{
  "eventView":{
    "endTime":"2021-10-31 23:59:59",
    "filts":[
      {
        "columnDesc":"城市",
        "columnName":"city",
        "comparator":"equal",
        "filterType":"SIMPLE",
        "ftv":[
          "上海市",
          "北京市",
          "广州市",
          "深圳市"],
        "specifiedClusterDate":"2022-01-24",
        "tableType":"user",
        "timeUnit":""
      }],
    "groupBy":[
      {
        "columnDesc":"城市",
        "columnName":"city",
        "propertyRange":"",
        "specifiedClusterDate":"2022-01-24",
        "tableType":"user"
      }],
    "recentDay":"",
    "relation":"and",
    "startTime":"2021-10-01 00:00:00",
    "taIdMeasureVo":{
      "columnDesc":"用户唯一ID",
      "columnName":"#user_id",
      "tableType":"event"
    },
    "windows_gap":1,
    "windows_gap_tu":"hour"
  },
  "events":[
    {
      "eventName":"register",
      "eventNameDisplay":"",
      "filts":[
        {
          "columnDesc":"app版本",
          "columnName":"app_version",
          "comparator":"equal",
          "filterType":"SIMPLE",
          "ftv":[
            "V1.0"],
          "specifiedClusterDate":"2022-01-26",
          "tableType":"event",
          "timeUnit":""
        }],
      "relation":"and"
    },
    {
      "eventName":"login",
      "eventNameDisplay":"",
      "filts":[
      ],
      "relation":"and"
    },
    {
      "eventName":"activity_attend",
      "eventNameDisplay":"",
      "filts":[
      ],
      "relation":"and"
    },
    {
      "eventName":"logout",
      "eventNameDisplay":"",
      "filts":[
      ],
      "relation":"and"
    }
  ],
  "projectId":377,
  "limit": 2,
  "timeoutSeconds": 10,
  "useCache": true
}

# リクエストパラメータ説明

パラメーター名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
eventView
-
Object
はい
グループ化プロパティ
endTime 2021-10-31 23:59:59
String
いいえ
終了時刻(形式: yyyy-MM-ddHH: mm: ss)、相対時刻が空の場合有効
filts -
List
いいえ
グローバルフィルタ項目
columnDesc 都市
String
いいえ
フィールド表示名
columnName city
String
はい
フィールド名
comparator equal
String
はい
参照:モデルクエリAPIのフィルター式
filterType SIMPLE
String
いいえ
フィルタモード、SIMPLE:シンプル、COMPOUND:コンポジット
ftv ["上海市"]
List
いいえ
プロパティの比較値
specifiedClusterDate 2022-01-24
String
いいえ
クラスター指定日
tableType user
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
timeUnit String
いいえ
プロパティは、relativeEvent*に対してのみ有効な値単位と比較します: day, hour, minute
groupBy -
List
いいえ
グループ化属性は、0個以上あり得る
columnDesc 都市
String
いいえ
フィールド表示名
columnName city
String
はい
フィールド名
propertyRange String
いいえ
カスタムプロパティ間隔
specifiedClusterDate 2022-01-24
String
いいえ
クラスター指定日
tableType user
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
recentDay String
いいえ
相対時間(開始時刻と終了時刻の両方で空であってはならない)
relation and
String
いいえ
論理関係、and:論理と、or:論理や
startTime 2021-10-01 00:00:00
String
いいえ
開始時間(形式: yyyy-MM-ddHH: mm: ss)、相対時間が空の場合有効
taIdMeasureVo -
Object
いいえ
本体構成の分析
columnDesc ユーザ固有ID
String
いいえ
フィールド表示名
columnName #user_id
String
はい
フィールド名
tableType event
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
windows_gap 1
Long
いいえ
ウィンドウの長さ
windows_gap_tu hour
String
いいえ
ウィンドウの長さの単位
秒:秒
minute:分
hour:時間
日:日
週:週
月:月
events
-
List
はい
イベントインジケータ一覧
eventName register
String
はい
イベント名、特別な、任意のイベントを表すためにanyEventを使用できます
eventNameDisplay String
いいえ
イベント表示名
filts -
List
いいえ
条件リスト
columnDesc アプリバージョン
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:ユーザテーブル
timeUnit String
いいえ
フィルタリング時間単位
relation and
String
いいえ
論理関係、and:論理と、or:論理や
projectId
377
Integer
はい
プロジェクトID
limit
2
Integer
いいえ
分析対象あたりのパケット数の上限、オプションパラメータは、デフォルトで1000、最大で10000
timeoutSeconds
10
Integer
いいえ
タイムアウトパラメーターが要求され、タイムアウトするとクエリタスク
useCache
true
Boolean
いいえ
キャッシュを使用します。オプションのパラメーターはデフォルトでtrueです

# 成功応答の例

{
  "data": {
    "result_generate_time": "2022-01-26 19:23:51",
    "total": 5,
    "x": [
      "2021-10-01",
      "2021-10-02",
      "2021-10-03",
      "2021-10-04",
      "2021-10-05",
      "2021-10-06",
      "2021-10-07",
      "2021-10-08",
      "2021-10-09",
      "2021-10-10",
      "2021-10-11",
      "2021-10-12",
      "2021-10-13",
      "2021-10-14",
      "2021-10-15",
      "2021-10-16",
      "2021-10-17",
      "2021-10-18",
      "2021-10-19",
      "2021-10-20",
      "2021-10-21",
      "2021-10-22",
      "2021-10-23",
      "2021-10-24",
      "2021-10-25",
      "2021-10-26",
      "2021-10-27",
      "2021-10-28",
      "2021-10-29",
      "2021-10-30",
      "2021-10-31"
    ],
    "y": [
      {
        "总体": {
          "col1": [
            5666,
            197,
            197,
            197
          ],
          "col2": [
            [
              208,
              10,
              10,
              10
            ],
            [
              205,
              4,
              4,
              4
            ],
            [
              189,
              5,
              5,
              5
            ],
            [
              229,
              10,
              10,
              10
            ],
            [
              217,
              6,
              6,
              6
            ],
            [
              257,
              10,
              10,
              10
            ],
            [
              233,
              6,
              6,
              6
            ],
            [
              207,
              7,
              7,
              7
            ],
            [
              204,
              7,
              7,
              7
            ],
            [
              248,
              14,
              14,
              14
            ],
            [
              217,
              4,
              4,
              4
            ],
            [
              207,
              9,
              9,
              9
            ],
            [
              219,
              8,
              8,
              8
            ],
            [
              220,
              4,
              4,
              4
            ],
            [
              193,
              10,
              10,
              10
            ],
            [
              218,
              9,
              9,
              9
            ],
            [
              232,
              7,
              7,
              7
            ],
            [
              222,
              10,
              10,
              10
            ],
            [
              220,
              8,
              8,
              8
            ],
            [
              203,
              6,
              6,
              6
            ],
            [
              217,
              8,
              8,
              8
            ],
            [
              239,
              3,
              3,
              3
            ],
            [
              214,
              5,
              5,
              5
            ],
            [
              197,
              11,
              11,
              11
            ],
            [
              199,
              8,
              8,
              8
            ],
            [
              135,
              7,
              7,
              7
            ],
            [
              73,
              1,
              1,
              1
            ],
            [
              33,
              0,
              0,
              0
            ],
            [
              11,
              0,
              0,
              0
            ],
            [
              0,
              0,
              0,
              0
            ],
            [
              0,
              0,
              0,
              0
            ]
          ]
        }
      },
      {
        "北京市": {
          "col1": [
            2028,
            70,
            70,
            70
          ],
          "col2": [
            [
              79,
              1,
              1,
              1
            ],
            [
              71,
              2,
              2,
              2
            ],
            [
              65,
              0,
              0,
              0
            ],
            [
              74,
              3,
              3,
              3
            ],
            [
              72,
              2,
              2,
              2
            ],
            [
              89,
              3,
              3,
              3
            ],
            [
              88,
              2,
              2,
              2
            ],
            [
              75,
              3,
              3,
              3
            ],
            [
              66,
              4,
              4,
              4
            ],
            [
              95,
              1,
              1,
              1
            ],
            [
              60,
              1,
              1,
              1
            ],
            [
              68,
              5,
              5,
              5
            ],
            [
              80,
              5,
              5,
              5
            ],
            [
              68,
              2,
              2,
              2
            ],
            [
              67,
              6,
              6,
              6
            ],
            [
              84,
              4,
              4,
              4
            ],
            [
              84,
              1,
              1,
              1
            ],
            [
              87,
              1,
              1,
              1
            ],
            [
              79,
              6,
              6,
              6
            ],
            [
              76,
              1,
              1,
              1
            ],
            [
              81,
              3,
              3,
              3
            ],
            [
              85,
              1,
              1,
              1
            ],
            [
              89,
              2,
              2,
              2
            ],
            [
              75,
              3,
              3,
              3
            ],
            [
              74,
              5,
              5,
              5
            ],
            [
              49,
              2,
              2,
              2
            ],
            [
              26,
              1,
              1,
              1
            ],
            [
              16,
              0,
              0,
              0
            ],
            [
              6,
              0,
              0,
              0
            ],
            [
              0,
              0,
              0,
              0
            ],
            [
              0,
              0,
              0,
              0
            ]
          ]
        }
      }
    ],
    "z": [
      "register",
      "login",
      "activity_attend",
      "logout"
    ]
  },
  "return_code": 0,
  "return_message": "success"
}

# 応答パラメータ説明

パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報
data
-
Object
結果を返す
result_generate_time 2022-01-01 00:00:00
String
計算結果生成時間
total 5
Integer
総数
x ["2021-10-01"]
List
時間リスト
y -
List
データリスト
z ["レジスター"]
List
イベント名リスト

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
参数(token)为空
String
戻る情報

# ファンネル分析ユーザーリスト

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String

トークン
projectId
0
Integer

プロジェクトID

# 要求 Body パラメーター

{
  "projectId": 0,
  "eventView": {
    "startTime": "2019-11-23 00:00:00",
    "endTime": "2019-11-26 00:00:00",
    "recentDay": "1-4",
    "relation": "and",
    "timeParticleSize": "day",
    "filts": [
      {
        "columnName": "user_level",
        "comparator": "equal",
        "ftv": [
          "5"
        ],
        "tableType": "user"
      }
    ],
    "groupBy": [
      {
        "columnName": "#province",
        "tableType": "event"
      }
    ]
  },
  "events": [
    {
      "eventName": "obtain_item",
      "relation": "and",
      "filts": [
        {
          "columnName": "#province",
          "comparator": "equal",
          "ftv": [
            "江苏省",
            "上海市"
          ],
          "tableType": "event"
        }
      ]
    }
  ],
  "sliceFunnelStep": 1,
  "sliceGroupVal": "['上海市']",
  "timeoutSeconds": 10
}

# リクエストパラメータ説明

パラメーター名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
projectId
0
String
はい
パラメーターの説明
eventView
-
Object
はい
グループ化属性テーブル
startTime 2019-11-24 00:00:00
String
いいえ
開始時間(形式: yyyy-MM-ddHH: mm: ss)、相対時間が空の場合有効
endTime 2019-11-26 00:00:00
String
いいえ
終了時刻(形式: yyyy-MM-ddHH: mm: ss)、相対時刻が空の場合有効
recentDay 1-3
String
いいえ
相対時間(開始時刻と終了時刻の両方で空であってはならない)
relation and
String
いいえ
論理関係、and:論理と、or:論理や
timeParticleSize day
String
はい
分析の時間単位
minute: 1分押す
minute5: 5分押す(v3.5サポート開始)
minute10: 10分押す(v3.5サポート開始)
hour:時間単位
day:日ごと
week:週ごと
月:月ごと
total:合計
filts -
List
いいえ
フィルタ項目一覧
columnName user_level
String
はい
フィールド名
comparator equal
String
はい
参照:モデルクエリAPIのフィルター式
ftv ["5"]
List
いいえ
プロパティの比較値
tableType user
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
groupBy -
List
いいえ
グループ化属性は、0個以上あり得る
columnName #province
String
はい
フィールド名
tableType event
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
events
List
はい
イベントインジケータ一覧
eventName obtain_item
String
はい
イベント名、特別な、任意のイベントを表すためにanyEventを使用できます
relation and
String
いいえ
論理関係、and:論理と、or:論理や
filts -
List
いいえ
フィルタ項目一覧
columnName #province
String
はい
フィールド名
comparator equal
String
はい
参照:モデルクエリAPIのフィルター式
ftv ["江蘇省"]
List
いいえ
プロパティの比較値
tableType event
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
sliceFunnelStep
1
Integer
はい
ファネルステップ,から1
sliceGroupVal
"['上海市']"
String
いいえ
グループ化
timeoutSeconds
10
Integer
いいえ
タイムアウトパラメーターが要求され、タイムアウトするとクエリタスク

# 成功応答の例

{
  "data": {
    "datalist": [
      {
        "#account_id": "u78082246",
        "#distinct_id": "u145009846",
        "user_level": 5,
        "register_time": "2019-11-26 09:59:34",
        "diamond_num": 1006,
        "latest_login_time": "2019-11-26 11:14:12",
        "channel": "小米应用商店",
        "#user_id": 33463846
      },
      {
        "#account_id": "k77655236",
        "#distinct_id": "k144216836",
        "user_level": 5,
        "register_time": "2019-11-24 08:53:09",
        "diamond_num": 1012,
        "latest_login_time": "2019-11-24 10:02:38",
        "channel": "豌豆荚",
        "#user_id": 33280836
      },
      {
        "#account_id": "a77648226",
        "#distinct_id": "a144203826",
        "user_level": 5,
        "register_time": "2019-11-24 08:21:19",
        "diamond_num": 1006,
        "latest_login_time": "2019-11-24 09:32:31",
        "channel": "应用宝",
        "#user_id": 33277826
      }
    ],
    "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
戻る情報