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

イベント分析モデルAPI

最終更新 2026/10/03

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

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

1. イベント分析クエリ​

インターフェースURL

/open/event-analyze?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

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

{
    "eventView": {
        "comparedByTime": true,
        "comparedStartTime": "2021-12-14 00:00:00",
        "comparedEndTime": "2021-12-20 23:59:59",
        "comparedRecentDay": "8-14",
        "startTime": "2021-12-21 00:00:00",
        "endTime": "2021-12-27 23:59:59",
        "recentDay": "1-7",
        "timeParticleSize": "day",
        "eventSplit": {
            "event": {
                "eventDesc": "ログイン",
                "eventName": "login"
            },
            "groupByProp": {
                "columnDesc": "ブラウザ",
                "columnName": "browser",
                "propertyRange": "",
                "tableType": "event"
            }
        },
        "groupBy": [{
            "columnDesc": "ブランド",
            "columnName": "brand",
            "propertyRange": "",
            "specifiedClusterDate": "2021-12-28",
            "tableType": "event"
        }],
        "relation": "and",
        "filts": [{
            "columnDesc": "ブランド",
            "columnName": "brand",
            "comparator": "equal",
            "filterType": "SIMPLE",
            "ftv": ["Apple", "Xiaomi"],
            "specifiedClusterDate": "2021-12-28",
            "tableType": "event",
            "timeUnit": ""
        }],
        "queryFeature": {
            "approximateOn": true,
            "globalQueryOn": false
        }
    },
    "events": [{
        "analysis": "TOTAL_TIMES",
        "analysisParams": "",
        "eventName": "login",
        "eventNameDisplay": "ログインの合計回数",
        "eventSplitIndexes": [0],
        "eventUuid": "7FonAy-G",
        "filts": [],
        "quota": "",
        "relation": "and",
        "type": "normal"
    }, {
        "analysis": "TRIG_USER_NUM",
        "analysisParams": "",
        "eventName": "activity_attend",
        "eventNameDisplay": "アクティビティ参加のユニークユーザー数",
        "eventUuid": "K9A5NDAz",
        "filts": [{
            "columnDesc": "appバージョン",
            "columnName": "app_version",
            "comparator": "notNull",
            "filterType": "SIMPLE",
            "ftv": [],
            "specifiedClusterDate": "2021-12-28",
            "tableType": "event",
            "timeUnit": ""
        }],
        "quota": "",
        "quotaEntities": [{
            "index": 0,
            "taIdMeasure": {
                "columnDesc": "ユーザー一意ID",
                "columnName": "#user_id",
                "tableType": "event"
            }
        }],
        "relation": "and",
        "type": "normal"
    }, {
        "customEvent": "logout.PER_CAPITA_TIMES",
        "customFilters": [],
        "eventName": "自定义指标",
        "eventNameDisplay": "",
        "eventSplitIndexes": [],
        "eventUuid": "gxqT19xz",
        "filts": [],
        "format": "float",
        "quota": "",
        "quotaEntities": [{
            "index": 0,
            "taIdMeasure": {
                "columnDesc": "メールアドレス",
                "columnName": "email",
                "tableType": "user"
            }
        }],
        "quotaTimeRanges": [{
            "index": 0,
            "params": ["1"],
            "type": "THIS_WEEK"
        }],
        "relation": "and",
        "type": "customized"
    }],
    "projectId": 377,
    "useSameResultKey": false,
    "useCache": true,
    "limit": 1000,
    "timeoutSeconds": 10,
    "zoneOffset": 10
}
ヒント

入力パラメータは複数の部分で構成されます。基本パラメータは必須です。時間比較パラメータ、イベント分割パラメータ、グループパラメータ、グローバルフィルターパラメータ、クエリ設定パラメータは任意です。通常の分析指標とカスタム分析指標はどちらか一方を指定します。

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
eventView-Objectはい指標の共通プロパティ部分
eventView.comparedByTimetrueBooleanいいえ時間比較を行うかどうか。TRUE：はい、FALSE：いいえ

eventView.comparedStartTime

2021-12-14 00:00:00String

いいえ

比較期間の開始時間（形式：yyyy-MM-dd HH:mm:ss）。比較期間の相対時間が空の場合に有効
eventView.comparedEndTime2021-12-20 23:59:59Stringいいえ比較期間の終了時間（形式：yyyy-MM-dd HH:mm:ss）。比較期間の相対時間が空の場合に有効
eventView.comparedRecentDay8-14Stringいいえ比較期間の相対時間（comparedByTimeがTRUEの場合、この項目と比較期間の開始時間・終了時間を同時に空にすることはできません）
eventView.startTime2021-12-21 00:00:00Stringいいえ開始時間（形式：yyyy-MM-dd HH:mm:ss）。相対時間が空の場合に有効
eventView.endTime2021-12-27 23:59:59Stringいいえ終了時間（形式：yyyy-MM-dd HH:mm:ss）。相対時間が空の場合に有効
eventView.recentDay1-7Stringいいえ相対時間（この項目と開始時間・終了時間を同時に空にすることはできません）
eventView.relationandStringいいえ論理関係。and：論理積、or：論理和
eventView.timeParticleSizedayStringはい

分析の時間単位

  • minute：1分単位
  • minute5：5分単位（v3.5以降対応）
  • minute10：10分単位（v3.5以降対応）
  • hour：時間単位
  • day：日単位
  • week：週単位
  • month：月単位
  • total：合計
eventView.eventSplit-Objectいいえイベント分割の情報
eventView.eventSplit.event-Objectはいイベント分割のイベント情報
eventView.eventSplit.event.eventDescログインStringいいえイベント分割指標の表示名
eventView.eventSplit.event.eventNameloginStringはいイベント分割指標のイベント名
eventView.eventSplit.groupByProp-Objectはいイベント分割指標のグループ情報
eventView.eventSplit.groupByProp.columnDescブラウザStringいいえイベント分割のグループフィールドの表示名
eventView.eventSplit.groupByProp.columnNamebrowserStringはいイベント分割のグループフィールドのフィールド名
eventView.eventSplit.groupByProp.propertyRangeStringいいえイベント分割のグループプロパティの区間
eventView.eventSplit.groupByProp.tableTypeeventStringはいテーブルタイプの列挙値
eventView.groupBy-Listいいえグループ化プロパティ。0個以上指定できます
eventView.groupBy.columnNamebrandStringはいフィールド名
eventView.groupBy.columnDescブランドStringいいえフィールドの表示名
eventView.groupBy.propertyRangeStringいいえカスタムプロパティの区間
eventView.groupBy.propertyRangeTypeStringいいえ

プロパティの区間タイプ。数値型プロパティをグループ化する場合、カスタムのバケット条件を指定できます

  • def：デフォルトの区間。システムが自動で分割
  • discrete：各値を独立したグループとする
  • user_defined：ユーザー定義。カスタム内容はpropertyRangeで設定
eventView.groupBy.specifiedClusterDate2021-12-28Stringいいえ指定した日付に対応するタグの履歴バージョン
eventView.groupBy.tableTypeeventStringはいテーブルタイプの列挙値
eventView.filts-Listいいえグローバルフィルター項目
eventView.filts.columnDescブランドStringいいえフィールドの表示名
eventView.filts.columnNamebrandStringはいフィールド名
eventView.filts.comparatorequalStringはい参考：モデルクエリAPIのフィルター式
eventView.filts.filterTypeSIMPLEStringいいえフィルターモード。SIMPLE：シンプル、COMPOUND：複合。デフォルトはSIMPLE
eventView.filts.ftv["Apple", "Xiaomi"]Listいいえプロパティ比較の境界に使用するリテラル定数
eventView.filts.specifiedClusterDate2021-12-28Stringいいえ指定した日付に対応するタグの履歴バージョン
eventView.filts.tableTypeeventStringはいテーブルタイプの列挙値
eventView.filts.timeUnitStringいいえプロパティ比較値の単位。relativeEvent*の場合のみ有効：day、hour、minute
eventView.queryFeature-Objectいいえクエリ設定
eventView.queryFeature.approximateOntrueBooleanいいえ近似計算を有効にするかどうか
events-Listはいイベント指標のリスト
events.analysisTRIG_USER_NUMStringいいえ分析の観点（集計操作）。詳しくはイベント集計タイプの列挙値を参照
events.analysisParamsStringいいえ分析の観点のパラメータ（analysisがPERCENTILEの場合は空にできません。値の範囲：1-100、何パーセンタイルかを表します）
events.eventNameactivity_attendStringはいイベント名。特に、anyEventで任意のイベントを表すことができます
events.eventNameDisplayアクティビティ参加のユニークユーザー数Stringいいえイベント表示名
events.metricNameretention_rate_1Stringいいえ

クエリする指標。固定化された分析基準を表します。

指標でクエリする場合、events.eventNameを「自定义指标」に設定できます

events.eventUuidK9A5NDAzStringいいえイベントUUID。イベントを一意に識別するために使用
events.filts-Listいいえ条件リスト
events.filts.columnDescアプリバージョンStringいいえフィールドの表示名
events.filts.columnNameapp_versionStringはいフィールド名
events.filts.comparatornotNullStringはい参考：モデルクエリAPIのフィルター式
events.filts.filterTypeSIMPLEStringいいえフィルターモード。SIMPLE：シンプル、COMPOUND：複合。デフォルトはSIMPLE
events.filts.ftv[]Listいいえプロパティ比較に使用する境界のリテラル定数
events.filts.specifiedClusterDate2021-12-28Stringいいえ指定した日付に対応するタグの履歴バージョン
events.filts.tableTypeeventStringはいテーブルタイプの列挙値
events.filts.timeUnitStringいいえフィルターの時間単位
events.quotaStringいいえ指標プロパティ（analysisと組み合わせて、どのプロパティのどの分析の観点かを表します）
events.quotaDescStringいいえ指標プロパティの表示名
events.quotaEntities-List分析イベント指標に対応する主体のリスト
events.quotaEntities.index0Integerはい分析イベント指標に対応する主体のインデックス
events.quotaEntities.taIdMeasure-ObjectクエリのID体系の設定
events.quotaEntities.taIdMeasure.columnDescユーザー一意IDStringいいえフィールドの表示名
events.quotaEntities.taIdMeasure.columnName#user_idStringはいフィールド名
events.quotaEntities.taIdMeasure.tableTypeeventStringはいテーブルタイプの列挙値
events.relationandStringいいえ論理関係。and：論理積、or：論理和
events.typenormalStringはい

normal：通常の分析

customized：カスタム数式

events.customEventlogout.PER_CAPITA_TIMESStringいいえ

計算式。分析項目または数値定数の加減乗除で構成します。分析項目にはeventName.columnName.analysisとeventName.analysisの2つの形式があります。

計算式に分析指標を含める場合は、固定のプレフィックス+指標名の形式を使用します。例：

$metric.metricName/eventName.columnName.analysisまたは

$metric.metricName1/$metric.metricName2

events.customFilters[]Listいいえ計算式のフィルター項目のリスト
events.eventName自定义指标Stringはい指標のイベント名。anyEventで任意イベントを指定できます
events.eventNameDisplayStringいいえカスタム指標の表示名
events.eventSplitIndexes[]Listいいえイベント分割の対象となる項目

events.format

floatStringいいえ

データの表示オプション

float：小数点以下2桁、float3：小数点以下3桁、float4：小数点以下4桁、percent：パーセント

events.quotaStringいいえ指標プロパティ（analysisと組み合わせて、どのプロパティのどの分析の観点かを表します）
events.quotaDescStringいいえ指標プロパティの表示名
events.quotaEntities-Listいいえ分析イベント指標に対応する主体のリスト
events.quotaEntities.index0Integerはい分析イベント指標に対応する主体のインデックス
events.quotaEntities.taIdMeasure-ObjectはいクエリのID体系の設定
events.quotaEntities.taIdMeasure.columnDescメールStringいいえフィールドの表示名
events.quotaEntities.taIdMeasure.columnNameemailStringはいフィールド名
events.quotaEntities.taIdMeasure.tableTypeuserStringはいテーブルタイプの列挙値
events.quotaTimeRanges[]Listいいえ指標の期間情報リスト
events.quotaTimeRanges.index0Integerはい期間のインデックス
events.quotaTimeRanges.params["1"]Listいいえ期間のパラメータ。events.quotaTimeRanges.typeがTIME_RANGEの場合、paramsが["-3", "4"]であれば、過去3日から未来4日までを表します
events.quotaTimeRanges.type

THIS_WEEK

Stringはい

期間のタイプ

LAST_DAYS：過去N日間、RECENT_DAYS：直近N日間、THIS_WEEK：今週、THIS_MONTH：今月、TIME_RANGE：時間範囲

events.relationandStringいいえ論理関係。and：論理積、or：論理和

events.type

customizedStringはい

normal：通常の分析

customized：カスタム数式

projectId377IntegerはいプロジェクトID
useSameResultKeyfalseBooleanいいえ

イベント名が同じ場合に、同じイベント名を使用するかどうか

true：同じイベント名を使用

false：イベント名が同じ場合、接頭辞として番号を付加

useCachetrueBooleanはいtrueの場合はキャッシュを使用
limit1000Integerいいえ分析対象ごとのグループ数の上限。任意パラメータで、デフォルトは1000、最大は10000
timeoutSeconds10Integerいいえリクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします
zoneOffset10Integerいいえタイムゾーン

成功レスポンスの例​

{
    "data": {
        "result_generate_time": "2021-12-30 11:15:41", 
        "union_groups": [
            [
                "Safari", 
                "Apple"
            ], 
            [
                "Firefox", 
                "Xiaomi"
            ], 
            [
                "WeChat内蔵ブラウザ", 
                "Apple"
            ], 
            [
                "全体", 
                "Apple"
            ], 
            [
                "全体", 
                "Xiaomi"
            ]
        ], 
        "x": [
            "2021-12-23", 
            "2021-12-24", 
            "2021-12-25", 
            "2021-12-26", 
            "2021-12-27", 
            "2021-12-28", 
            "2021-12-29"
        ], 
        "x_compared": [
            "2021-12-16", 
            "2021-12-17", 
            "2021-12-18", 
            "2021-12-19", 
            "2021-12-20", 
            "2021-12-21", 
            "2021-12-22"
        ], 
        "y": [
            {
                "login.TOTAL_TIMES": [
                    {
                        "group_cols": [
                            "Safari", 
                            "Apple"
                        ], 
                        "group_num": 3, 
                        "values": [
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0"
                        ], 
                        "values_compared": [
                            "447", 
                            "980", 
                            "1584", 
                            "321", 
                            "285", 
                            "74", 
                            "0"
                        ]
                    }, 
                    {
                        "group_cols": [
                            "Firefox", 
                            "Xiaomi"
                        ], 
                        "group_num": 3, 
                        "values": [
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0"
                        ], 
                        "values_compared": [
                            "291", 
                            "818", 
                            "1128", 
                            "272", 
                            "219", 
                            "58", 
                            "0"
                        ]
                    }, 
                    {
                        "group_cols": [
                            "WeChat内蔵ブラウザ", 
                            "Apple"
                        ], 
                        "group_num": 3, 
                        "values": [
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0"
                        ], 
                        "values_compared": [
                            "231", 
                            "500", 
                            "764", 
                            "214", 
                            "155", 
                            "35", 
                            "0"
                        ]
                    }
                ]
            }, 
            {
                "activity_attend.TRIG_USER_NUM": [
                    {
                        "group_cols": [
                            "全体", 
                            "Apple"
                        ], 
                        "group_num": 2, 
                        "values": [
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0"
                        ], 
                        "values_compared": [
                            "640", 
                            "811", 
                            "1251", 
                            "1253", 
                            "720", 
                            "113", 
                            "0"
                        ]
                    }, 
                    {
                        "group_cols": [
                            "全体", 
                            "Xiaomi"
                        ], 
                        "group_num": 2, 
                        "values": [
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0", 
                            "0"
                        ], 
                        "values_compared": [
                            "277", 
                            "439", 
                            "600", 
                            "666", 
                            "364", 
                            "59", 
                            "0"
                        ]
                    }
                ]
            }, 
            {
                "自定义指标": [
                    {
                        "group_cols": [
                            "全体", 
                            "Apple"
                        ], 
                        "group_num": 2, 
                        "values": [
                            "1", 
                            "1", 
                            "1", 
                            "1", 
                            "0", 
                            "0", 
                            "0"
                        ], 
                        "values_compared": [
                            "1.01", 
                            "1.01", 
                            "1.01", 
                            "1.01", 
                            "1", 
                            "1", 
                            "1"
                        ]
                    }, 
                    {
                        "group_cols": [
                            "全体", 
                            "Xiaomi"
                        ], 
                        "group_num": 2, 
                        "values": [
                            "1", 
                            "1", 
                            "1", 
                            "1", 
                            "0", 
                            "0", 
                            "0"
                        ], 
                        "values_compared": [
                            "1.01", 
                            "1.01", 
                            "1.01", 
                            "1.01", 
                            "1", 
                            "1", 
                            "1"
                        ]
                    }
                ]
            }
        ]
    }, 
    "return_code": 0, 
    "return_message": "success"
}

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

$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Object戻り値
data.result_generate_time2021-12-29 12:00:00Stringクエリ結果の生成時間
data.union_groups["Apple"]Listすべてのグループの集合
data.x["2021-12-23"]ListX軸の時間
data.x_compared["2021-12-16"]ListX軸の比較時間
data.y-ListY軸のデータリスト
data.y.{指標名}-ListY軸の指標情報リスト
data.y.{指標名}.group_cols["Apple"]ListY軸の指標グループ
data.y.{指標名}.group_num3IntegerY軸の指標グループ数
data.y.{指標名}.values["0"]ListY軸の指標値
data.y.{指標名}.values_compared["447"]ListY軸の時間比較の指標値
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

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

curlの例

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"projectId": 377,"useSameResultKey": false,"useCache": true,"limit": 1000,"eventView": {"comparedByTime": true,"comparedStartTime": "2021-12-14 00:00:00","comparedEndTime": "2021-12-20 23:59:59","comparedRecentDay": "8-14","startTime": "2021-12-21 00:00:00","endTime": "2021-12-27 23:59:59","recentDay": "1-7","relation": "and","timeParticleSize": "day","eventSplit": {"event": {"eventDesc": "ログイン","eventName": "login"},"groupByProp": {"columnDesc": "ブラウザ","columnName": "browser","propertyRange": "","tableType": "event"}},"groupBy": [{"columnDesc": "ブランド","columnName": "brand","propertyRange": "","specifiedClusterDate": "2021-12-28","tableType": "event"}],"filts": [{"columnDesc": "ブランド","columnName": "brand","comparator": "equal","filterType": "SIMPLE","ftv": ["Apple", "Xiaomi"],"specifiedClusterDate": "2021-12-28","tableType": "event","timeUnit": ""}],"queryFeature": {"approximateOn": true,"globalQueryOn": false}},"events": [{"analysis": "TOTAL_TIMES","analysisParams": "","eventName": "login","eventNameDisplay": "ログインの合計回数","eventSplitIndexes": [0],"eventUuid": "7FonAy-G","filts": [],"quota": "","relation": "and","type": "normal"}, {"analysis": "TRIG_USER_NUM","analysisParams": "","eventName": "activity_attend","eventNameDisplay": "アクティビティ参加のユニークユーザー数","eventUuid": "K9A5NDAz","filts": [{"columnDesc": "appバージョン","columnName": "app_version","comparator": "notNull","filterType": "SIMPLE","ftv": [],"specifiedClusterDate": "2021-12-28","tableType": "event","timeUnit": ""}],"quota": "","quotaEntities": [{"index": 0,"taIdMeasure": {"columnDesc": "ユーザー一意ID","columnName": "#user_id","tableType": "event"}}],"relation": "and","type": "normal"}, {"customEvent": "logout.PER_CAPITA_TIMES","customFilters": [],"eventName": "自定义指标","eventNameDisplay": "","eventSplitIndexes": [],"eventUuid": "gxqT19xz","filts": [],"format": "float","quota": "","quotaEntities": [{"index": 0,"taIdMeasure": {"columnDesc": "メールアドレス","columnName": "email","tableType": "user"}}],"quotaTimeRanges": [{"index": 0,"params": ["1"],"type": "THIS_WEEK"}],"relation": "and","type": "customized"}]}' 'http://ta2:8992/open/event-analyze?token=YOUR_TOKEN'

2. イベント分析のフルダウンロード​

インターフェースURL

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

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

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

{
    "eventView": {
            "endTime": "2022-03-07 16:32:12",
            "filts": [{
                    "columnDesc": "レベル",
                    "columnName": "level",
                    "comparator": "greater",
                    "filterType": "SIMPLE",
                    "ftv": ["1"],
                    "specifiedClusterDate": "2022-03-08",
                    "tableType": "event",
                    "timeUnit": ""
            }],
            "groupBy": [{
                    "columnDesc": "channel",
                    "columnName": "channel",
                    "propertyRange": "",
                    "specifiedClusterDate": "2022-03-08",
                    "tableType": "event"
            }],
            "recentDay": "1-7",
            "relation": "and",
            "startTime": "2022-03-01 16:32:12",
            "timeParticleSize": "day"
    },
    "events": [{
            "analysis": "TOTAL_TIMES",
            "analysisParams": "",
            "eventName": "LogOut",
            "eventNameDisplay": "LogOutの合計回数",
            "eventUuid": "QgfCSkCw",
            "filts": [],
            "quota": "",
            "relation": "and",
            "type": "normal"
    }],
    "projectId": 319,
    "zoneOffset": 10
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId0Stringはいパラメータの説明
eventView-Objectはいパラメータの内容はイベント分析クエリAPIと同じです
eventsListはいパラメータの内容はイベント分析クエリAPIと同じです
zoneOffset10Integerいいえタイムゾーン
ヒント

リクエストパラメータはAEシステムのイベント分析ページから直接エクスポートできます

レスポンス​

AEシステムのイベント分析のフルダウンロードと同じ

3. イベント分析のユーザーリスト​

インターフェースURL

/open/event-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",
    "timeParticleSize": "day",
    "groupBy": [
      {
        "columnName": "#city",
        "tableType": "event"
      }
    ]
  },
  "events": [
    {
      "analysis": "TRIG_USER_NUM",
      "eventName": "consume_item",
      "quota": "#vp@dailyTask",
      "relation": "and",
      "type": "normal",
      "filts": [
      {
          "columnName": "user_level",
          "comparator": "equal",
          "ftv": [
            "5"
          ],
          "tableType": "user"
        }
      ],
    }
  ],
  "sliceDate": "2019-11-26",
  "eventIndex": 0,
  "sliceGroupVal": [
    "北京市"
  ],
  "timeoutSeconds": 10,
  "zoneOffset": 10
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId0Stringはいパラメータの説明
eventView-Objectはいパラメータの内容はイベント分析クエリAPIと同じです
eventsListはいパラメータの内容はイベント分析クエリAPIと同じです
sliceDate"2019-11-26"Stringいいえドリルダウンする日付
sliceGroupVal["北京市"]Listはいドリルダウンするグループ
eventIndex0intはいドリルダウンする指標の番号（0から開始）
timeoutSeconds10Integerいいえリクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします
zoneOffset10Integerいいえタイムゾーン

成功レスポンスの例​

{
  "data": {
    "datalist": [
      {
        "#account_id": "e78107482",
        "#distinct_id": "e145056682",
        "user_level": 5,
        "register_time": "2019-11-26 14:36:13",
        "diamond_num": 1006,
        "latest_login_time": "2019-11-26 15:45:16",
        "channel": "app store",
        "#user_id": 33474682
      },
      {
        "#account_id": "d7819213",
        "#distinct_id": "d14521393",
        "user_level": 5,
        "register_time": "2019-11-26 23:25:14",
        "diamond_num": 858,
        "first_recharge_time": "2019-11-26 23:29:56",
        "latest_login_time": "2019-11-26 23:32:48",
        "channel": "app store",
        "#user_id": 3351093
      }
    ],
    "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/event-user-list?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

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

{
    "eventView": {
        "comparedByTime": false,
        "comparedRecentDay": "",
        "endTime": "2022-03-07 16:32:12",
        "filts": [
            {
                "columnDesc": "レベル",
                "columnName": "level",
                "comparator": "greater",
                "filterType": "SIMPLE",
                "ftv": [
                    "1"
                ],
                "specifiedClusterDate": "2022-03-08",
                "tableType": "event",
                "timeUnit": ""
            }
        ],
        "groupBy": [
            {
                "columnDesc": "channel",
                "columnName": "channel",
                "propertyRange": "",
                "specifiedClusterDate": "2022-03-08",
                "tableType": "event"
            }
        ],
        "recentDay": "1-7",
        "relation": "and",
        "startTime": "2022-03-01 16:32:12",
        "timeParticleSize": "day"
    },
    "events": [
        {
            "analysis": "TRIG_USER_NUM",
            "analysisParams": "",
            "eventName": "LogOut",
            "eventNameDisplay": "LogOutのユニークユーザー数",
            "eventUuid": "QgfCSkCw",
            "filts": [],
            "quota": "",
            "quotaEntities": [
                {
                    "index": 0,
                    "taIdMeasure": {
                        "columnDesc": "ユーザー一意ID",
                        "columnName": "#user_id",
                        "tableType": "event"
                    }
                }
            ],
            "relation": "and",
            "type": "normal"
        }
    ],
    "projectId": 319,
    "sliceDate": "2022-03-01",
    "eventIndex": 0,
    "sliceGroupVal": [
        "AppStore"
    ],
    "selectedColumns": [
        "#account_id",
        "#distinct_id",
        "accountid"
    ],
    "zoneOffset": 10
}

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

$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId0Stringはいパラメータの説明
eventView-Objectはいパラメータの内容はイベント分析クエリAPIと同じです
eventsListはいパラメータの内容はイベント分析クエリAPIと同じです
sliceDate"2019-11-26"Stringいいえドリルダウンする日付
sliceGroupVal["北京市"]Listはいドリルダウンするグループ
eventIndex0intはいドリルダウンする指標の番号（0から開始）
selectedColumns["#account_id"]Listはいダウンロードする列
zoneOffset10Integerいいえタイムゾーン
ヒント

リクエストパラメータは、AEシステムのイベント分析ページからパラメータの本体構造を直接エクスポートし、sliceDate、eventIndex、eventDate、sliceGroupVal、selectedColumnsの各パラメータを追加します。具体的なパラメータ値はページのAPIリクエストから取得できます

レスポンス​

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

イベント分析の共通列挙値​

イベント集計タイプの列挙値​

値説明プロパティが必要か
TOTAL_TIMES合計回数いいえ
TRIG_USER_NUMユニークユーザー数いいえ
PER_CAPITA_TIMES一人当たり回数いいえ
SUM数値の合計はい
AVG数値の平均値はい
PER_CAPITA_NUM一人当たり値はい
MAX数値の最大値はい
MIN数値の最小値はい
DISTINCT重複除外数はい
TRUETrue totalsはい
FALSEFalse totalsはい
IS_NOT_EMPTYNot null totalsはい
IS_EMPTYNull totalsはい
ARRAY_DISTINCTリストのユニーク数はい
ARRAY_SET_DISTINCTセットのユニーク数はい
ARRAY_ITEM_DISTINCT要素のユニーク数はい
MEDIAN中央値はい
PERCENTILEパーセンタイルはい
このページは役に立ちましたか？
このページの内容