manuallatest製品マニュアル / 指標クエリ API
指標クエリ API
呼び出し方法は、Open APIドキュメントの呼び出し方法の説明を参照してください。
AE使用マニュアルを先に読んで、指標関連の機能を理解しておくことをお勧めします：指標
1. 利用可能な指標のリストを照会する
条件に基づいて指標の定義を照会します
インターフェースURL
/open/metric-list?token=xxx
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
リクエストbodyパラメータの説明
{
"projectId": 102,
"metricName": "retention_1", //指標名-あいまい一致に対応
"metricDesc": "翌日継続", // 指標表示名-あいまい一致に対応
"metricModes": ["EVENT","RETENTION"], // 指標の作成元
"createUser":"root", //作成者
"updateUser":"root", //最終更新者
"timeParticleSize":"day" //指標が対応する時間粒度
}
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| projectId | 102 | Integer | はい | プロジェクトID |
| metricName | retention_1 | String | いいえ | 指標名-あいまい一致に対応 |
| metricDesc | 翌日継続 | String | いいえ | 指標表示名-あいまい一致に対応 |
| metricModes | ["EVENT", "RETENTION"] | List | いいえ | 指標の作成元 EVENT-イベント指標 RETENTION-継続指標 |
| createUser | root | String | いいえ | 指標作成者のログイン名 |
| updateUser | root | String | いいえ | 指標更新者のログイン名 |
| timeParticle | day | String | いいえ | 指標が対応する時間単位
|
レスポンスパラメータの説明
{
"data":
[
{
"metricId": 1,
"projectId": 2,
"metricName": "retention_1",
"metricDesc": "翌日継続",
"metricRemark": "登録ユーザーの翌日継続",
"metricMode": "EVENT",
"createUser": "root",
"updateUser": "root",
"createTime": "2022-12-12 10:10:00",
"updateTime": "2022-12-12 10:10:00",
"timeParticles":[ "minute"],
"format": "FORMAT_FLOAT"
}
],
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| data | - | 戻り値 | |
| data.metricId | 1 | Long | 指標ID |
| data.projectId | 102 | Integer | 指標が属するプロジェクトID |
| data.metricName | retention_1 | String | 指標名 |
| data.metricDesc | 翌日継続 | String | 指標表示名 |
| data.metricRemark | 登録ユーザーの翌日継続 | String | 指標の備考 |
| data.metricMode | RETENTION | String | 指標の作成元 |
| data.createUser | root | String | 指標の作成ユーザー |
| data.updateUser | root | String | 指標の更新ユーザー |
| data.createTime | 2022-12-12 10:10:00 | Date | 指標の作成日 |
| data.updateTime | 2022-12-12 10:10:00 | Date | 指標の更新日 |
| data.timeParticles | ['day', 'hour', 'month'] | List | 指標が対応する時間単位
|
| data.format | FORMAT_FLOAT | String | 指標の形式
|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
2. 指標データを照会する
インターフェースURL
/open/metric-data?token=xxx
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
リクエスト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",
"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
}
},
"metrics":["retention_1","dau"],
"zoneOffset": 0,
"projectId": 377,
"useSameResultKey": false,
"useCache": true,
"limit": 1000,
"timeoutSeconds": 10
}
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| eventView | - | Object | はい | 指標の共通プロパティ部分 |
| eventView.comparedByTime | true | Boolean | いいえ | 時間比較を行うかどうか。TRUE：はい、FALSE：いいえ |
eventView.comparedStartTime | 2021-12-14 00:00:00 | String | いいえ | 比較期間の開始時間（形式：yyyy-MM-dd HH:mm:ss）。比較期間の相対時間が空の場合に有効 |
| eventView.comparedEndTime | 2021-12-20 23:59:59 | String | いいえ | 比較期間の終了時間（形式：yyyy-MM-dd HH:mm:ss）。比較期間の相対時間が空の場合に有効 |
| eventView.comparedRecentDay | 8-14 | String | いいえ | 比較期間の相対時間（comparedByTimeがTRUEの場合、この項目と比較期間の開始時間・終了時間を同時に空にすることはできません） |
| eventView.startTime | 2021-12-21 00:00:00 | String | いいえ | 開始時間（形式：yyyy-MM-dd HH:mm:ss）。相対時間が空の場合に有効 |
| eventView.endTime | 2021-12-27 23:59:59 | String | いいえ | 終了時間（形式：yyyy-MM-dd HH:mm:ss）。相対時間が空の場合に有効 |
| eventView.recentDay | 1-7 | String | いいえ | 相対時間（この項目と開始時間・終了時間を同時に空にすることはできません） |
| eventView.relation | and | String | いいえ | 論理関係。and：論理積、or：論理和 |
eventView.timeParticleSize | day | String | はい | 分析の時間単位
|
| eventView.groupBy | - | List | いいえ | グループ化プロパティ。0個以上指定できます |
| eventView.groupBy.columnName | brand | String | はい | フィールド名 |
| eventView.groupBy.columnDesc | ブランド | String | いいえ | フィールドの表示名 |
| eventView.groupBy.propertyRange | String | いいえ | カスタムプロパティの区間 | |
| eventView.groupBy.propertyRangeType | String | いいえ | プロパティの区間タイプ。数値型プロパティをグループ化する場合、カスタムのバケット条件を指定できます
| |
| eventView.groupBy.specifiedClusterDate | 2021-12-28 | String | いいえ | 指定した日付に対応するタグの履歴バージョン |
| eventView.groupBy.tableType | event | String | はい | テーブルタイプの列挙値 |
| eventView.filts | - | List | いいえ | グローバルフィルター項目 |
| eventView.filts.columnDesc | ブランド | String | いいえ | フィールドの表示名 |
| eventView.filts.columnName | brand | String | はい | フィールド名 |
| eventView.filts.comparator | equal | String | はい | 参考：モデルクエリAPIのフィルター式 |
| eventView.filts.filterType | SIMPLE | String | いいえ | フィルターモード。SIMPLE：シンプル、COMPOUND：複合。デフォルトはSIMPLE |
| eventView.filts.ftv | ["Apple", "Xiaomi"] | List | いいえ | プロパティ比較の境界に使用するリテラル定数 |
| eventView.filts.specifiedClusterDate | 2021-12-28 | String | いいえ | 指定した日付に対応するタグの履歴バージョン |
| eventView.filts.tableType | event | String | はい | テーブルタイプの列挙値 |
| eventView.filts.timeUnit | String | いいえ | プロパティ比較値の単位。relativeEvent*の場合のみ有効：day、hour、minute | |
| eventView.queryFeature | - | Object | いいえ | クエリ設定 |
| eventView.queryFeature.approximateOn | true | Boolean | いいえ | 近似計算を有効にするかどうか |
| metrics | ["retention_1","dau"] | list | はい | 指標名のリスト |
| projectId | 377 | Integer | はい | プロジェクトID |
zoneOffset | 0 | Integer | いいえ | 使用するタイムゾーン |
| useCache | true | Boolean | いいえ | キャッシュを使用します。任意のパラメータで、デフォルトはtrueです |
| limit | 1000 | Integer | いいえ | 分析対象ごとのグループ数の上限。任意パラメータで、デフォルトは1000、最大は10000 |
| timeoutSeconds | 10 | Integer | いいえ | リクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします |
成功レスポンスの例
{
"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": [
{
"retention_1": [
{
"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"
]
}
]
},
{
"dau": [
{
"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"
]
}
]
}
]
},
"return_code": 0,
"return_message": "success"
}
レスポンスパラメータの説明
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| data | - | Object | 戻り値 |
| data.result_generate_time | 2021-12-29 12:00:00 | String | クエリ結果の生成時間 |
| data.union_groups | ["Apple"] | List | すべてのグループの集合 |
| data.x | ["2021-12-23"] | List | X軸の時間 |
| data.x_compared | ["2021-12-16"] | List | X軸の比較時間 |
| data.y | - | List | Y軸のデータリスト |
| data.y.{指標名} | - | List | Y軸の指標情報リスト |
| data.y.{指標名}.group_cols | ["Apple"] | List | Y軸の指標グループ |
| data.y.{指標名}.group_num | 3 | Integer | Y軸の指標グループ数 |
| data.y.{指標名}.values | ["0"] | List | Y軸の指標値 |
| data.y.{指標名}.values_compared | ["447"] | List | Y軸の時間比較の指標値 |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
このページは役に立ちましたか？