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

リテンション分析モデル API

最終更新 2026/10/03

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

ユーザーマニュアルの リテンション分析 で利用シーンを確認できます。

1. リテンション分析のクエリ​

インターフェースURL

/open/retention-analyze?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

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

{
  "eventView":{
    "endTime":"2021-10-30 23:59:59",
    "filts":[
      {
        "columnDesc":"appバージョン",
        "columnName":"app_version",
        "comparator":"equal",
        "filterType":"SIMPLE",
        "ftv":[
          "V1.0"],
        "specifiedClusterDate":"2022-01-24",
        "tableType":"event",
        "timeUnit":""
      }],
    "firstDayOfWeek":1,
    "groupBy":[
      {
        "columnDesc":"ブラウザ",
        "columnName":"browser",
        "propertyRange":"",
        "specifiedClusterDate":"2022-01-24",
        "tableType":"event"
      }],
    "recentDay":"",
    "relation":"and",
    "startTime":"2021-10-01 00:00:00",
    "statType":"retention",
    "taIdMeasureVo":{
      "columnDesc":"ユーザー一意ID",
      "columnName":"#user_id",
      "tableType":"event"
    },
    "timeParticleSize":"week",
    "unitNum":1
  },
  "events":[
    {
      "eventName":"login",
      "eventNameDisplay":"",
      "filts":[
        {
          "columnDesc":"app_version",
          "columnName":"app_version",
          "comparator":"equal",
          "filterType":"SIMPLE",
          "ftv":["V1.0"],
          "specifiedClusterDate":"2022-01-26",
          "tableType":"event",
          "timeUnit":""
        }],
      "relation":"and",
      "relationUser":"and",
      "type":"first"
    },
    {
      "eventName":"logout",
      "eventNameDisplay":"",
      "filts":[
      ],
      "relation":"and",
      "relationUser":"and",
      "type":"second"
    },
    {
      "analysis":"TOTAL_TIMES",
      "analysisDesc":"合計回数",
      "eventName":"activity_attend",
      "eventNameDisplay":"",
      "filts":[
      ],
      "quota":"",
      "relation":"and",
      "relationUser":"and",
      "type":"simultaneous_display"
    }],
    "projectId": 377,
    "limit": 2,
    "timeoutSeconds": 10,
    "useCache": true,
    "zoneOffset": 10
}

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

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

eventView.timeParticleSize

week

String

はい

分析の時間単位

  • day：日単位
  • week：週単位
  • month：月単位
eventView.unitNum1Integerはい継続期間
events-Listはいイベント指標のリスト
events.eventNameloginStringはい指標のイベント名。anyEventで任意イベントを指定できます
events.eventNameDisplayStringいいえカスタム指標の表示名
events.analysisTRIG_USER_NUMStringいいえ分析の観点（集計操作）。詳しくは継続の同時表示の集計タイプの列挙値を参照
events.analysisDesc合計回数Stringいいえ分析の観点の説明
events.quotaStringいいえ指標プロパティ（analysisと組み合わせて、どのプロパティのどの分析の観点かを表します）
events.filts-Listいいえ条件リスト
events.filts.columnDescapp_versionStringいいえフィールドの表示名
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：論理和
events.relationUserandStringいいえユーザーフィルターの論理関係。and：論理積、or：論理和

events.type

first

Stringはい

継続のイベントタイプ

  • first：開始イベント
  • second：復帰イベント
  • simultaneous_display：同時表示
  • init_date_stat：開始日付指標
projectId377IntegerはいプロジェクトID
limit2Integerいいえ分析対象ごとのグループ数の上限。任意パラメータで、デフォルトは1000、最大は10000
timeoutSeconds10Integerいいえリクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします
useCachetrueBooleanはいtrueの場合はキャッシュを使用
zoneOffset10Integerいいえタイムゾーン

成功レスポンスの例​

{
  "data": {
    "result_generate_time": "2022-01-01 00:00:00",
    "state_avg": {
      "0": [
        {
          "groupCols": [
            "全体"
          ],
          "initNum": 0,
          "isTotal": 1,
          "lastValidDateVerticalIndexs": [
            "-",
            "4"
          ],
          "values": [
            "-",
            "0.998"
          ]
        },
        {
          "groupCols": [
            "Chrome"
          ],
          "initNum": 0,
          "isTotal": 0,
          "lastValidDateVerticalIndexs": [
            "-",
            "4"
          ],
          "values": [
            "-",
            "0.9981"
          ]
        }
      ],
      "1": [
        {
          "groupCols": [
            "全体"
          ],
          "initNum": 0,
          "isTotal": 1,
          "lastValidDateVerticalIndexs": [
            "-",
            "4"
          ],
          "values": [
            "-",
            "1"
          ]
        },
        {
          "groupCols": [
            "Chrome"
          ],
          "initNum": 0,
          "isTotal": 0,
          "lastValidDateVerticalIndexs": [
            "-",
            "4"
          ],
          "values": [
            "-",
            "1"
          ]
        }
      ],
      "2": [
        {
          "groupCols": [
            "全体"
          ],
          "initNum": 0,
          "isTotal": 1,
          "lastValidDateVerticalIndexs": [],
          "values": [
            "-",
            "132405.4"
          ]
        },
        {
          "groupCols": [
            "Chrome"
          ],
          "initNum": 0,
          "isTotal": 0,
          "lastValidDateVerticalIndexs": [],
          "values": [
            "-",
            "66343.2"
          ]
        }
      ]
    },
    "x": [
      "2021-09-27",
      "2021-10-04",
      "2021-10-11",
      "2021-10-18",
      "2021-10-25"
    ],
    "y": {
      "0": {
        "2021-09-27": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 7388,
            "isTotal": 1,
            "values": [
              "7388",
              "7374"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 3647,
            "isTotal": 0,
            "values": [
              "3647",
              "3642"
            ]
          }
        ],
        "2021-10-04": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 7861,
            "isTotal": 1,
            "values": [
              "7861",
              "7844"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 3939,
            "isTotal": 0,
            "values": [
              "3939",
              "3930"
            ]
          }
        ],
        "2021-10-11": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 8013,
            "isTotal": 1,
            "values": [
              "8013",
              "7994"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 4062,
            "isTotal": 0,
            "values": [
              "4062",
              "4054"
            ]
          }
        ],
        "2021-10-18": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 8553,
            "isTotal": 1,
            "values": [
              "8553",
              "8543"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 4225,
            "isTotal": 0,
            "values": [
              "4225",
              "4218"
            ]
          }
        ],
        "2021-10-25": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 7414,
            "isTotal": 1,
            "values": [
              "7414",
              "7397"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 3741,
            "isTotal": 0,
            "values": [
              "3741",
              "3733"
            ]
          }
        ]
      },
      "1": {
        "2021-09-27": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 7388,
            "isTotal": 1,
            "values": [
              "7388",
              "7388"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 3647,
            "isTotal": 0,
            "values": [
              "3647",
              "3647"
            ]
          }
        ],
        "2021-10-04": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 7861,
            "isTotal": 1,
            "values": [
              "7861",
              "7861"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 3939,
            "isTotal": 0,
            "values": [
              "3939",
              "3939"
            ]
          }
        ],
        "2021-10-11": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 8013,
            "isTotal": 1,
            "values": [
              "8013",
              "8013"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 4062,
            "isTotal": 0,
            "values": [
              "4062",
              "4062"
            ]
          }
        ],
        "2021-10-18": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 8553,
            "isTotal": 1,
            "values": [
              "8553",
              "8553"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 4225,
            "isTotal": 0,
            "values": [
              "4225",
              "4225"
            ]
          }
        ],
        "2021-10-25": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 7414,
            "isTotal": 1,
            "values": [
              "7414",
              "7414"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 3741,
            "isTotal": 0,
            "values": [
              "3741",
              "3741"
            ]
          }
        ]
      },
      "2": {
        "2021-09-27": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 7388,
            "isTotal": 1,
            "values": [
              "0",
              "125324"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 3647,
            "isTotal": 0,
            "values": [
              "0",
              "62105"
            ]
          }
        ],
        "2021-10-04": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 7861,
            "isTotal": 1,
            "values": [
              "0",
              "132130"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 3939,
            "isTotal": 0,
            "values": [
              "0",
              "65971"
            ]
          }
        ],
        "2021-10-11": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 8013,
            "isTotal": 1,
            "values": [
              "0",
              "134691"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 4062,
            "isTotal": 0,
            "values": [
              "0",
              "68566"
            ]
          }
        ],
        "2021-10-18": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 8553,
            "isTotal": 1,
            "values": [
              "0",
              "144030"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 4225,
            "isTotal": 0,
            "values": [
              "0",
              "71345"
            ]
          }
        ],
        "2021-10-25": [
          {
            "groupCols": [
              "全体"
            ],
            "includeToday": false,
            "initNum": 7414,
            "isTotal": 1,
            "values": [
              "0",
              "125852"
            ]
          },
          {
            "groupCols": [
              "Chrome"
            ],
            "includeToday": false,
            "initNum": 3741,
            "isTotal": 0,
            "values": [
              "0",
              "63729"
            ]
          }
        ]
      }
    },
    "z": [
      "login",
      "logout",
      "activity_attend"
    ]
  },
  "return_code": 0,
  "return_message": "success"
}

レスポンスパラメータの説明​

$$パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ
data-Object戻り値
data.result_generate_time2022-01-01 00:00:00String計算結果の生成日時
data.state_avg-Object結果のmap。keyはtype、valueは継続のグループ
data.state_avg.{type}-Listtypeの値。0：継続、1：離脱、2：同時表示指標
data.state_avg.{type}.groupCols["全体"]Listグループ列
data.state_avg.{type}.initNum0Integer初期値
data.state_avg.{type}.isTotal1Integer合計行かどうか。1：はい、0：いいえ
data.state_avg.{type}.lastValidDateVerticalIndexs["-", "4"]List最後の完全なデータの日付インデックス
data.state_avg.{type}.values["-", "0.998"]List値のリスト。"-"または数値
data.x["2021-09-27"]List日付リスト
data.y-Objecty軸のデータ
data.y.{type}-Objecttypeの値。0：継続、1：離脱、2：統計
data.y.{type}.{date}-Listkeyは日付
data.y.{type}.{date}.groupCols["全体"]Listグループ列
data.y.{type}.{date}.includeTodayfalseBoolean本日を含むかどうか
data.y.{type}.{date}.initNum7388Integer初期値
data.y.{type}.{date}.isTotal1Integer合計行かどうか。1：はい、0：いいえ
data.y.{type}.{date}.values["7388"]List値のリスト
data.z["login"]Listイベント名のリスト

エラーレスポンスの例

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

2. リテンション分析の全件ダウンロード​

インターフェースURL

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

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

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

{
        "eventView": {
                "collectFirstDay": 1,
                "endTime": "2022-03-08 16:55:10",
                "filts": [],
                "groupBy": [{
                        "columnDesc": "チャネル",
                        "columnName": "channel",
                        "propertyRange": "",
                        "specifiedClusterDate": "2022-03-09",
                        "tableType": "event"
                }],
                "recentDay": "1-7",
                "relation": "and",
                "startTime": "2022-03-02 16:55:10",
                "statType": "retention",
                "taIdMeasureVo": {
                        "columnDesc": "ユーザー一意ID",
                        "columnName": "#user_id",
                        "tableType": "event"
                },
                "timeParticleSize": "day",
                "unitNum": 7
        },
        "events": [{
                "eventName": "Recharge",
                "eventNameDisplay": "",
                "filts": [],
                "relation": "and",
                "relationUser": "and",
                "type": "first"
        }],
        "projectId": 390
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
eventView-Objectはいパラメータの内容はリテンション分析のクエリAPIと同じ
events-Listはいパラメータの内容はリテンション分析のクエリAPIと同じ
projectId377IntegerはいプロジェクトID
zoneOffset10Integerいいえタイムゾーン

レスポンス​

AEシステムのリテンション分析の全件ダウンロードと同じ

3. リテンション分析のユーザーリスト​

インターフェースURL

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

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

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

{
  "projectId": 0,
  "eventView": {
    "startTime": "2019-11-24 00:00:00",
    "endTime": "2019-11-26 00:00:00",
    "recentDay": "1-3",
    "statType": "retention",
    "timeParticleSize": "day",
    "unitNum": 7,
    "groupBy": [
      {
        "columnName": "#province",
        "tableType": "event"
      }
    ]
  },
  "events": [
    {
      "type": "first",
      "relation": "and",
      "eventName": "player_register",
      "filts": [
        {
          "columnName": "#province",
          "comparator": "equal",
          "ftv": [
            "江蘇省",
            "上海市"
          ],
          "tableType": "event"
        },
        {
          "columnName": "user_level",
          "comparator": "greater",
          "ftv": [
            "2"
          ],
          "tableType": "user"
        }
      ]
    },
    {
      "type": "second",
      "relation": "and",
      "eventName": "obtain_diamond",
      "filts": [
        {
          "columnName": "#os",
          "comparator": "equal",
          "ftv": [
            "android"
          ],
          "tableType": "event"
        },
        {
          "$ref": "$.events[0].filts[1]"
        }
      ]
    }
  ],
  "sliceDate": "2019-11-26",
  "sliceInterval": 3,
  "timeoutSeconds": 10,
  "zoneOffset": 10
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId0Stringはいパラメータの説明
eventView-Objectはいパラメータの内容はリテンション分析のクエリAPIと同じ
eventsListはいパラメータの内容はリテンション分析のクエリAPIと同じ
sliceDate"2019-11-26"Stringいいえドリルダウンする日付
sliceGroupVal["北京市"]Listはいドリルダウンするグループ

sliceInterval

3Listはい

ドリルダウンする継続間隔

  • 0：開始イベントユーザー数
  • 1：当日
  • 2：1日後
  • 3：2日後
timeoutSeconds10Integerいいえリクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします
zoneOffset10Integerいいえタイムゾーン

成功レスポンスの例​

{
  "data": {
    "datalist": [
      {
        "#account_id": "v47739399",
        "#distinct_id": "v88658799",
        "user_level": 11,
        "register_time": "2019-11-26 19:13:20",
        "diamond_num": 1182,
        "latest_login_time": "2019-11-26 20:16:19",
        "channel": "Huawei AppGallery",
        "#user_id": 20459799
      },
      {
        "#account_id": "i7819568",
        "#distinct_id": "i14522048",
        "user_level": 4,
        "register_time": "2019-11-26 23:56:17",
        "diamond_num": 1006,
        "latest_login_time": "2019-11-26 23:59:59",
        "channel": "360モバイルアシスタント",
        "#user_id": 3351248
      },
      {
        "#account_id": "g7812426",
        "#distinct_id": "g14508786",
        "user_level": 14,
        "register_time": "2019-11-26 17:54:13",
        "diamond_num": 245,
        "first_recharge_time": "2019-11-26 18:08:58",
        "latest_login_time": "2019-11-26 20:16:19",
        "channel": "Xiaomi GetApps",
        "#user_id": 3348186
      },
      {
        "#account_id": "a7812000",
        "#distinct_id": "a14508000",
        "user_level": 3,
        "register_time": "2019-11-26 17:27:28",
        "diamond_num": 1153,
        "latest_login_time": "2019-11-26 18:45:58",
        "channel": "app store",
        "#user_id": 3348000
      }
    ],
    "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/retention-user-list?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

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

{
    "eventView": {
            "collectFirstDay": 1,
            "endTime": "2022-03-07 17:09:58",
            "filts": [],
            "groupBy": [],
            "recentDay": "1-7",
            "relation": "and",
            "startTime": "2022-03-01 17:09:58",
            "statType": "retention",
            "taIdMeasureVo": {
                    "columnDesc": "User ID",
                    "columnName": "#user_id",
                    "tableType": "event"
            },
            "timeParticleSize": "day",
            "unitNum": 7
    },
    "events": [{
            "eventName": "Login",
            "eventNameDisplay": "",
            "filts": [],
            "relation": "and",
            "relationUser": "and",
            "type": "first"
    }, {
            "eventName": "Recharge",
            "eventNameDisplay": "",
            "filts": [],
            "relation": "and",
            "relationUser": "and",
            "type": "second"
    }],
    "projectId": 319,
    "isLost": false,
    "sliceDate": "2022-03-01",
    "sliceInterval": 0,
    "selectedColumns": ["#account_id", "#distinct_id"],
    "zoneOffset": 10
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
eventView-Objectはいパラメータの内容はリテンション分析のクエリAPIと同じ
events-Listはいパラメータの内容はリテンション分析のクエリAPIと同じ
projectId377IntegerはいプロジェクトID
isLostfalsebooleanいいえ離脱かどうか
sliceDate"2019-11-26"Stringいいえイベントが発生した日付
sliceGroupVal["北京市"]Listはいドリルダウンするグループ
sliceInterval0Integerはい

ドリルダウンする継続間隔

  • 0：開始イベントユーザー数
  • 1：当{日付単位}
  • 2：1{日付単位}後
  • 3：2{日付単位}後
selectedColumns["#account_id"]Listはいダウンロードする列
zoneOffset10Integerいいえタイムゾーン
ヒント

リクエストパラメータの本体はAEシステムのリテンション分析ページからエクスポートでき、それにisLost、sliceDate、sliceGroupVal、sliceInterval、selectedColumnsのパラメータを追加します

レスポンス​

AEシステムのリテンション分析のユーザーリスト全件ダウンロードと同じ

リテンション分析の共通列挙値​

継続の同時表示の集計タイプの列挙値​

値説明プロパティが必要か
TOTAL_TIMES合計回数いいえ
TRIG_USER_NUMユニークユーザー数いいえ
PER_CAPITA_TIMES一人当たり回数いいえ
SUM数値の合計はい
PER_CAPITA_NUM一人当たり値はい
STAGE_ACC累積合計はい
STAGE_ACC_PCV累積一人当たり平均値はい
TRUETrue totalsはい
FALSEFalse totalsはい
IS_NOT_EMPTYNot null totalsはい
IS_EMPTYNull totalsはい
このページは役に立ちましたか？
このページの内容