• 发送查询请求到 Cube
  • 请求体
    • 跟踪事件示例
    • 会话示例
• 发送元数据请求到 Cube

{{< details >}}

• Tier: 旗舰版
• Offering: JihuLab.com, 私有化部署
• Status: Beta

{{< /details >}}

{{< history >}}

• 引入于极狐GitLab 15.4，使用名为 cube_api_proxy 的功能标志。默认禁用。
• 在极狐GitLab 15.10 中，cube_api_proxy 被移除并用 product_analytics_internal_preview 代替。
• 在极狐GitLab 16.11 中，product_analytics_dashboards 替代了 product_analytics_internal_preview。
• 在极狐GitLab 16.11 中，product_analytics_dashboards 默认启用。
• 在极狐GitLab 17.1 中，功能标志 product_analytics_dashboards 被移除。
• 在极狐GitLab 17.5 中，更改为 beta，并使用名为 product_analytics_features 的功能标志。

{{< /history >}}

{{< alert type=”flag” >}}

此功能的可用性受控于功能标志。更多信息，可查看历史。此变更还未生产就绪。

{{< /alert >}}

{{< alert type=”note” >}}

请确保首先使用 API 定义了 cube_api_base_url 和 cube_api_key 应用设置。

{{< /alert >}}

发送查询请求到 Cube

生成一个可用于查询 Cube API 的访问令牌。例如：

POST /projects/:id/product_analytics/request/load
POST /projects/:id/product_analytics/request/dry-run

请求体

加载请求的请求体必须是一个有效的 Cube 查询。

{{< alert type=”note” >}}

当测量 TrackedEvents 时，必须使用 TrackedEvents.* 作为 dimensions 和 timeDimensions。相同的规则适用于测量 Sessions。

{{< /alert >}}

跟踪事件示例

{
  "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