InfoGrab Docs

제품 분석 API

요약

이 기능의 사용 가능 여부는 기능 플래그로 제어됩니다. 이 API를 사용하여 사용자 행동 및 애플리케이션 사용량을 추적합니다. 먼저 API를 사용하여 cube_api_base_url 및 cube_api_key 애플리케이션 설정을 정의하세요.

히스토리
  • GitLab 15.4에서 cube_api_proxy라는 플래그와 함께 도입되었습니다. 기본적으로 비활성화됨.
  • cube_api_proxy가 GitLab 15.10에서 제거되고 product_analytics_internal_preview로 교체되었습니다.
  • product_analytics_internal_preview가 GitLab 15.11에서 product_analytics_dashboards로 교체되었습니다.
  • product_analytics_dashboards가 GitLab 16.11에서 기본적으로 활성화되었습니다.
  • 기능 플래그 product_analytics_dashboards가 GitLab 17.1에서 제거되었습니다.
  • GitLab 17.5에서 product_analytics_features라는 플래그와 함께 베타로 변경되었습니다.
Feature flag

이 기능의 사용 가능 여부는 기능 플래그로 제어됩니다. 자세한 내용은 히스토리를 참조하세요. 이 기능은 프로덕션 환경에 준비되지 않았습니다.

이 API를 사용하여 사용자 행동 및 애플리케이션 사용량을 추적합니다.

Note

먼저 API를 사용하여 cube_api_base_urlcube_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 쿼리여야 합니다.

Note

TrackedEvents를 측정할 때는 dimensionstimeDimensionsTrackedEvents.*를 사용해야 합니다. 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.

제품 분석 API

Tier: Ultimate
Offering: GitLab.com, GitLab Self-Managed
원문 보기
요약

이 기능의 사용 가능 여부는 기능 플래그로 제어됩니다. 이 API를 사용하여 사용자 행동 및 애플리케이션 사용량을 추적합니다. 먼저 API를 사용하여 cube_api_base_url 및 cube_api_key 애플리케이션 설정을 정의하세요.

히스토리
  • GitLab 15.4에서 cube_api_proxy라는 플래그와 함께 도입되었습니다. 기본적으로 비활성화됨.
  • cube_api_proxy가 GitLab 15.10에서 제거되고 product_analytics_internal_preview로 교체되었습니다.
  • product_analytics_internal_preview가 GitLab 15.11에서 product_analytics_dashboards로 교체되었습니다.
  • product_analytics_dashboards가 GitLab 16.11에서 기본적으로 활성화되었습니다.
  • 기능 플래그 product_analytics_dashboards가 GitLab 17.1에서 제거되었습니다.
  • GitLab 17.5에서 product_analytics_features라는 플래그와 함께 베타로 변경되었습니다.
Feature flag

이 기능의 사용 가능 여부는 기능 플래그로 제어됩니다. 자세한 내용은 히스토리를 참조하세요. 이 기능은 프로덕션 환경에 준비되지 않았습니다.

이 API를 사용하여 사용자 행동 및 애플리케이션 사용량을 추적합니다.

Note

먼저 API를 사용하여 cube_api_base_urlcube_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 쿼리여야 합니다.

Note

TrackedEvents를 측정할 때는 dimensionstimeDimensionsTrackedEvents.*를 사용해야 합니다. 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.