目录
此内容是否有帮助?

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

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

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

# リテンション分析クエリ

インターフェイス URL

/open/retention-analyze?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

# 要求 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
}

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

パラメーター名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
eventView
-
Object
はい
グループ化プロパティ
endTime 2021-10-30 23:59:59
String
いいえ
終了時刻(形式: yyyy-MM-ddHH: mm: ss)、相対時刻が空の場合有効
filts -
List
いいえ
グローバルフィルタ項目
columnDesc アプリバージョン
String
いいえ
フィールド表示名
columnName app_version
String
はい
フィールド名
comparator equal
String
はい
参照:モデルクエリAPIのフィルター式
filterType SIMPLE
String
いいえ
フィルタモード、SIMPLE:シンプル、COMPOUND:コンポジット
ftv ["V1.0"]
List
いいえ
プロパティの比較値
specifiedClusterDate 2022-01-24
String
いいえ
クラスター指定日
tableType event
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
timeUnit String
いいえ
プロパティは、relativeEvent*に対してのみ有効な値単位と比較します: day, hour, minute
firstDayOfWeek 1
Integer
いいえ
timeParticleSizeがweekの場合、週の初日、1:月曜日、2:火曜日、...、7:日曜日、最小1、最大7
groupBy -
List
いいえ
グループ化属性は、0個以上あり得る
columnDesc ブラウザ
String
いいえ
フィールド表示名
columnName browser
String
はい
フィールド名
propertyRange String
いいえ
カスタムプロパティ間隔
specifiedClusterDate 2022-01-24
String
いいえ
クラスター指定日
tableType event
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
recentDay String
いいえ
相対時間(開始時刻と終了時刻の両方で空であってはならない)
relation and
String
いいえ
論理関係、and:論理と、or:論理や
startTime 2021-10-01 00:00:00
String
いいえ
開始時間(形式: yyyy-MM-ddHH: mm: ss)、相対時間が空の場合有効
statType retention
String
はい
統計の種類、保持: retention、損失: lost
taIdMeasureVo -
Object
いいえ
本体構成の分析
columnDesc ユーザ固有ID
String
いいえ
フィールド表示名
columnName #user_id
String
はい
フィールド名
tableType event
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
timeParticleSize week
String
はい
分析の時間単位
minute: 1分押す
minute5: 5分押す(v3.5サポート開始)
minute10: 10分押す(v3.5サポート開始)
hour:時間単位
day:日ごと
week:週ごと
月:月ごと
total:合計
unitNum 1
Integer
はい
保持期間
events
-
List
はい
イベントインジケータ一覧
eventName login
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:論理や
relationUser and
String
いいえ
ユーザは論理関係をフィルタし、and: logicaland, or: logicalor
type first
String
はい
イベントの種類を保持し、
first:初期イベント
second:コールバックイベント
同時表示:同時に見せる
init_date_stat:初期日付インジケータ
projectId
377
Integer
はい
プロジェクトID
limit
2
Integer
いいえ
分析対象あたりのパケット数の上限、オプションパラメータは、デフォルトで1000、最大で10000
timeoutSeconds
10
Integer
いいえ
タイムアウトパラメーターが要求され、タイムアウトするとクエリタスク
useCache
true
Boolean
いいえ
キャッシュを使用します。オプションのパラメーターはデフォルトでtrueです

同時に表示集計方法 analysis 値:

値です
説明
プロパティが必要かどうか
TOTAL_TIMES
合計回数
いいえ
TRIG_USER_NUM
トリガーユーザー数
いいえ
PER_CAPITA_TIMES
一人当たりの回数
いいえ
SUM
数値の合計
はい
PER_CAPITA_NUM
人の平均
はい
STAGE_ACC
ステージ累計合計
はい
STAGE_ACC_PCV
段階累積人平均
はい
TRUE
真の数です
はい
FALSE
偽の数です
はい
IS_NOT_EMPTY
空でない
はい
IS_EMPTY
空の数です
はい

# 成功応答の例

{
  "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_code
0
Integer
リターンコード
return_message
success
String
戻る情報
data
-
Object
結果を返す
result_generate_time 2022-01-01 00:00:00
String
計算結果生成時間
state_avg -
Object
結果map、keyはtype、valueは予約パケット
{type} -
List
type値、0:保持、1:消失、2:統計
groupCols ["全体"]
List
グループ列
initNum 0
Integer
初期値
isTotal 1
Integer
集計かどうか、1:はい、0:いいえ
lastValidDateVerticalIndexs ["-", "4"]
List
最後の有効な日付インデックス
values ["-", "0.998"]
List
値のリスト、"-"または数値
x ["2021-09-27"]
List
日付リスト
y -
Object
y軸データ
{type} -
Object
type値、0:保持、1:消失、2:統計
{date} -
List
keyは日付です
groupCols ["全体"]
List
グループ化列
includeToday false
Boolean
今日を含むか
initNum 7388
Integer
初期値
isTotal 1
Integer
集計かどうか、1:はい、0:いいえ
values ["7388"]
List
値のリスト
z ["login"]
List
イベント名リスト

エラー応答の例

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

# 分析ユーザーリストを保持

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

トークン

# 要求 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
}

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

パラメーター名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
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
いいえ
相対時間(開始時刻と終了時刻の両方で空であってはならない)
statType retention
String
統計の種類、保持: retention、損失: lost
timeParticleSize day
String
はい
分析の時間単位
minute: 1分押す
minute5: 5分押す(v3.5サポート開始)
minute10: 10分押す(v3.5サポート開始)
hour:時間単位
day:日ごと
week:週ごと
月:月ごと
total:合計
unitNum 7
Integer
保持期間
groupBy -
List
いいえ
グループ化属性は、0個以上あり得る
columnName #province
String
はい
フィールド名
tableType event
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
events
List
はい
イベントインジケータ一覧
type first
String
はい
first:初期イベント
second:コールバックイベント
同時表示:同時に見せる
init_date_stat:初期日付インジケータ
eventName player_register
String
はい
イベント名、特別な、任意のイベントを表すためにanyEventを使用できます
relation and
String
いいえ
論理関係、and:論理と、or:論理や
filts -
List
いいえ
フィルタ項目一覧
columnName #province
String
はい
フィールド名
comparator equal
String
はい
参照:モデルクエリAPIのフィルター式
ftv ["江蘇省"]
List
いいえ
プロパティの比較値
tableType event
String
はい
テーブルタイプ、event:イベントテーブル、user:ユーザテーブル
sliceDate
"2019-11-26"
String
いいえ
イベントの日付
sliceInterval
3
List
はい
期間の下付き
0:初期イベントユーザー数
1:当日
2: 1後日
3: 2後日
timeoutSeconds
10
Integer
いいえ
タイムアウトパラメーターが要求され、タイムアウトするとクエリタスク

# 成功応答の例

{
  "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": "华为应用市场",
        "#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": "小米应用商店",
        "#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_code
0
Integer
リターンコード
return_message
success
String
戻る情報
data
-
Object
結果を返す
data.datalist
-
List
ユーザー情報
data.columMeta
-
Map
フィールド意味マッピング

エラー応答の例

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