プロダクト分析API
- プラン: Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed
- ステータス: ベータ
この機能の利用可否は、機能フラグによって制御されます。詳細については、履歴を参照してください。この機能は本番環境での使用には対応していません。
このAPIを使用して、ユーザーの行動とアプリケーションの使用状況を追跡します。
APIを使用して、最初にcube_api_base_urlおよびcube_api_keyアプリケーションの設定を定義してください。
Cubeにクエリリクエストを送信する
Cube APIにクエリするために使用できるアクセストークンを生成します。例:
POST /projects/:id/product_analytics/request/load
POST /projects/:id/product_analytics/request/dry-run| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | 現在のユーザーが読み取りアクセスできるプロジェクトのID。 |
include_token | ブール値 | いいえ | レスポンスにアクセストークンを含めるかどうか。（ファンネルの生成にのみ必要）。 |
リクエストボディ
ロードリクエストの本文は、有効なCubeクエリである必要があります。
TrackedEventsを測定する場合は、dimensionsとtimeDimensionsにTrackedEvents.*を使用する必要があります。同じルールはSessionsを測定する場合にも適用されます。
追跡イベントの例
{
"query": {
"measures": [
"TrackedEvents.count"
],
"timeDimensions": [
{
"dimension": "TrackedEvents.utcTime",
"dateRange": "This week"
}
],
"order": [
[
"TrackedEvents.count",
"desc"
],
[
"TrackedEvents.docPath",
"desc"
],
[
"TrackedEvents.utcTime",
"asc"
]
],
"dimensions": [
"TrackedEvents.docPath"
],
"limit": 23
},
"queryType": "multi"
}セッションの例
{
"query": {
"measures": [
"Sessions.count"
],
"timeDimensions": [
{
"dimension": "Sessions.startAt",
"granularity": "day"
}
],
"order": {
"Sessions.startAt": "asc"
},
"limit": 100
},
"queryType": "multi"
}Cubeにメタデータリクエストを送信する
分析データのCubeメタデータを返します。例:
GET /projects/:id/product_analytics/request/meta| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | 現在のユーザーが読み取りアクセスできるプロジェクトのID。 |