제품 분석 API

Tier: Ultimate Offering: GitLab.com
  • GitLab 15.4에서 cube_api_proxy라는 플래그로 소개되었습니다. 기본 상태에서 비활성화됩니다.
  • GitLab 15.10에서 cube_api_proxy가 제거되고 product_analytics_internal_preview로 대체되었습니다.
  • GitLab 15.11에서 product_analytics_internal_preview가 product_analytics_dashboards로 대체되었습니다.
Self-managed GitLab 및 GitLab Dedicated에서는 기본적으로 이 기능을 사용할 수 없습니다. 프로젝트별로 또는 인스턴스 전체에 사용할 수 있도록 하려면 관리자가 cube_api_proxy라는 피처 플래그를 활성화해야 합니다. GitLab.com에서는 이 기능을 사용할 수 있습니다. 이 기능은 제품화용이 아닙니다.
note
먼저 API를 사용하여 cube_api_base_url 및 cube_api_key 애플리케이션 설정을 정의해야 합니다.

큐브에 쿼리 요청 보내기

큐브 API를 쿼리하는 데 사용할 수 있는 액세스 토큰을 생성합니다. 예: 

POST /projects/:id/product_analytics/request/load
POST /projects/:id/product_analytics/request/dry-run
속성 유형 필요 여부 설명
id 정수 예 현재 사용자가 읽기 권한을 갖고 있는 프로젝트의 ID.
include_token 부울 아니요 응답에 액세스 토큰을 포함해야 하는지 여부. (퍼널 생성에만 필요)

요청 본문

로드 요청의 본문은 유효한 큐브 쿼리여야 합니다.

note
TrackedEvents를 메트릭할 때 dimensions 및 timeDimensions에 대해 TrackedEvents.*를 사용해야 합니다. Sessions를 메트릭할 때도 동일한 규칙이 적용됩니다.

추적된 이벤트 예시 

{
  "query": {
    "measures": [
      "TrackedEvents.count"
    ],
    "timeDimensions": [
      {
        "dimension": "TrackedEvents.utcTime",
        "dateRange": "이번 주"
      }
    ],
    "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"
}

큐브에 메타데이터 요청 보내기

분석 데이터의 큐브 메타데이터를 반환합니다. 예: 

GET /projects/:id/product_analytics/request/meta
속성 유형 필요 여부 설명
id 정수 예 현재 사용자가 읽기 권한을 갖고 있는 프로젝트의 ID.

프로젝트의 퍼널 나열

프로젝트의 모든 퍼널을 나열합니다. 예: 

GET /projects/:id/product_analytics/funnels
속성 유형 필요 여부 설명
id 정수 예 현재 사용자가 개발자 역할을 갖고 있는 프로젝트의 ID.