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

フロー分析モデル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いいえbetween
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_WeChat内蔵ブラウザ^_^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_WeChat内蔵ブラウザ^_^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": "WeChat内蔵ブラウザ",
          "event_name": "login",
          "id": "0_WeChat内蔵ブラウザ^_^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はいパラメータの内容はフロー分析のクエリAPIと同じ
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リターンメッセージ
このページは役に立ちましたか？
このページの内容