メインコンテンツまでスキップ

ファネル分析モデルAPI

最終更新 2026/10/05

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

利用シーンについては、マニュアルのファネル分析を参照してください。

1. ファネル分析クエリ​

インターフェースURL

/open/funnel-analyze?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー

リクエスト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,
  "zoneOffset": 10
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
eventView-Objectはい指標の共通プロパティ部分
eventView.endTime2021-10-31 23:59:59Stringいいえ終了時間（形式：yyyy-MM-dd HH:mm:ss）。相対時間が空の場合に有効
eventView.filts-Listいいえグローバルフィルター項目
eventView.filts.columnDesc都市Stringいいえフィールドの表示名
eventView.filts.columnNamecityStringはいフィールド名
eventView.filts.comparatorequalStringはい参考：モデルクエリAPIのフィルター式
eventView.filts.filterTypeSIMPLEStringいいえフィルターモード。SIMPLE：シンプル、COMPOUND：複合
eventView.filts.ftv["上海市"]Listいいえプロパティ比較の境界に使用するリテラル定数
eventView.filts.specifiedClusterDate2022-01-24Stringいいえ指定した日付に対応するタグの履歴バージョン
eventView.filts.tableTypeuserStringはいテーブルタイプの列挙値
eventView.filts.timeUnitStringいいえプロパティ比較値の単位。relativeEvent*の場合のみ有効：day、hour、minute
eventView.groupBy-Listいいえグループ化プロパティ。0個以上指定できます
eventView.groupBy.columnDesc都市Stringいいえフィールドの表示名
eventView.groupBy.columnNamecityStringはいフィールド名
eventView.groupBy.propertyRangeStringいいえカスタムプロパティの区間
eventView.groupBy.specifiedClusterDate2022-01-24Stringいいえ指定した日付に対応するタグの履歴バージョン
eventView.groupBy.tableTypeuserStringはいテーブルタイプの列挙値
eventView.recentDayStringいいえ相対時間（この項目と開始時間・終了時間を同時に空にすることはできません）
eventView.relationandStringいいえ論理関係。and：論理積、or：論理和
eventView.startTime2021-10-01 00:00:00Stringいいえ開始時間（形式：yyyy-MM-dd HH:mm:ss）。相対時間が空の場合に有効
eventView.taIdMeasureVo-Objectいいえ分析主体の設定
eventView.taIdMeasureVo.columnDescユーザー一意IDStringいいえフィールドの表示名
eventView.taIdMeasureVo.columnName#user_idStringはいフィールド名
eventView.taIdMeasureVo.tableTypeeventStringはいテーブルタイプの列挙値
eventView.windows_gap1Longいいえウィンドウ期間
eventView.windows_gap_tuhourStringいいえ

ウィンドウ期間の単位：

  • second：秒
  • minute：分
  • hour：時間
  • day：日
  • week：週
  • month：月
events-Listはいイベント指標のリスト
events.eventNameregisterStringはい指標のイベント名。anyEventで任意イベントを指定できます
events.eventNameDisplayStringいいえカスタム指標の表示名
events.filts-Listいいえフィルター条件のリスト
events.filts.columnDescアプリバージョンStringいいえフィールドの表示名
events.filts.columnNameapp_versionStringはいフィールド名
events.filts.comparatorequalStringはい参考：モデルクエリAPIのフィルター式
events.filts.filterTypeSIMPLEStringいいえフィルターモード。SIMPLE：シンプル、COMPOUND：複合
events.filts.ftv["V1.0"]Listいいえプロパティ比較の境界に使用するリテラル定数
events.filts.specifiedClusterDate2022-01-26Stringいいえ指定した日付に対応するタグの履歴バージョン
events.filts.tableTypeeventStringはいテーブルタイプの列挙値
events.filts.timeUnitStringいいえフィルターの時間単位
events.relationandStringいいえ論理関係。and：論理積、or：論理和
projectId377IntegerはいプロジェクトID
limit2Integerいいえ分析対象ごとのグループ数の上限。任意パラメータで、デフォルトは1000、最大は10000
timeoutSeconds10Integerいいえリクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします
useCachetrueBooleanはいtrueの場合はキャッシュを使用
zoneOffset10Integerいいえタイムゾーン

成功レスポンスの例​

{
  "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_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ
data-Object戻り値
data.result_generate_time2022-01-01 00:00:00String計算結果の生成日時
data.total5Integer総数
data.x["2021-10-01"]List時間のリスト
data.y-List<Map>データのリスト
data.z["register"]Listイベント名のリスト

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageパラメータ(token)が空ですStringリターンメッセージ

2. ファネル分析のフルダウンロード​

インターフェースURL

/open/streaming-download/funnel-analyze?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー

リクエストBodyパラメータ​

{
    "eventView": {
        "endTime": "2022-03-07 17:27:29",
        "filts": [],
        "groupBy": [],
        "recentDay": "1-7",
        "relation": "and",
        "startTime": "2022-03-01 17:27:29",
        "taIdMeasureVo": {
            "columnDesc": "User ID",
            "columnName": "#user_id",
            "tableType": "event"
        },
        "windows_gap": 1,
        "windows_gap_tu": "day"
    },
    "events": [{
        "eventName": "Login",
        "eventNameDisplay": "",
        "filts": [],
        "relation": "and"
    }, {
        "eventName": "LogOut",
        "eventNameDisplay": "",
        "filts": [],
        "relation": "and"
    }],
    "projectId": 319,
    "timeView": "TOTAL_TIME",
    "resultType": "CONVERSION",
    "zoneOffset": 10
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
eventView-Objectはいパラメータの内容はファネル分析クエリAPIと同じです
events-Listはいパラメータの内容はファネル分析クエリAPIと同じです
projectId377IntegerはいプロジェクトID
timeViewTOTAL_TIMEStringいいえ時間の観点：TOTAL_TIME(合計)、PER_DATE(日単位)
resultTypeCONVERSIONStringいいえ結果タイプ：CONVERSION（コンバージョン）、DROP_OFF（離脱）
zoneOffset10Integerいいえタイムゾーン

レスポンス​

AEシステムのファネル分析のフルダウンロードと同じ

3. ファネル分析のユーザーリスト​

インターフェースURL

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

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0Integerはいプロジェクト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,
  "zoneOffset": 10
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId0Stringはいパラメータの説明
eventView-Objectはいパラメータの内容はファネル分析クエリAPIと同じです
eventsListはいパラメータの内容はファネル分析クエリAPIと同じです
sliceFunnelStep1Integerはいドリルダウンするファネルステップ（1から開始）
sliceGroupVal"['上海市']"Listいいえドリルダウンするグループ
sliceWastageUserfalseBooleanいいえ離脱ユーザーかどうか。true：はい、false：いいえ
timeoutSeconds10Integerいいえリクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします
zoneOffset10Integerいいえタイムゾーン

成功レスポンスの例​

{
  "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": "Xiaomi GetApps",
        "#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": "Wandoujia",
        "#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": "Tencent MyApp",
        "#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_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リターンメッセージ

4. ファネル分析のユーザーリストのダウンロード​

インターフェースURL

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

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー

リクエストBodyパラメータ​

{
    "eventView": {
        "endTime": "2022-03-07 17:27:29",
        "filts": [],
        "groupBy": [],
        "recentDay": "1-7",
        "relation": "and",
        "startTime": "2022-03-01 17:27:29",
        "taIdMeasureVo": {
                "columnDesc": "User ID",
                "columnName": "#user_id",
                "tableType": "event"
        },
        "windows_gap": 1,
        "windows_gap_tu": "day"
    },
    "events": [{
        "eventName": "Login",
        "eventNameDisplay": "",
        "filts": [],
        "relation": "and"
    }, {
        "eventName": "LogOut",
        "eventNameDisplay": "",
        "filts": [],
        "relation": "and"
    }],
    "projectId": 319,
    "sliceFunnelStep": 1,
    "sliceWastageUser": false,
    "selectedColumns": ["#account_id", "#distinct_id"],
    "zoneOffset": 10
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId0Stringはいパラメータの説明
eventView-Objectはいパラメータの内容はファネル分析クエリAPIと同じです
eventsListはいパラメータの内容はファネル分析クエリAPIと同じです
sliceFunnelStep1Integerはいドリルダウンするファネルステップ（1から開始）
sliceGroupVal"['上海市']"Listいいえドリルダウンするグループ
sliceWastageUserfalseBooleanいいえ離脱ユーザーかどうか。true：はい、false：いいえ
selectedColumns["#account_id", "#distinct_id"]Arrayいいえダウンロードする列
zoneOffset10Integerいいえタイムゾーン

レスポンス​

AEシステムのファネル分析のユーザーリストのダウンロードと同じ

このページは役に立ちましたか？
このページの内容