Product analytics API

Tier: Ultimate Offering: GitLab.com
History
  • Introduced in GitLab 15.4 with a flag named cube_api_proxy. Disabled by default.
  • cube_api_proxy removed and replaced with product_analytics_internal_preview in GitLab 15.10.
  • product_analytics_internal_preview replaced with product_analytics_dashboards in GitLab 15.11.
  • product_analytics_dashboards enabled by default in GitLab 16.11.
On self-managed GitLab and GitLab Dedicated, by default this feature is not available. To make it available per project or for your entire instance, an administrator can enable the feature flag named cube_api_proxy. On GitLab.com, this feature is available. This feature is not ready for production use.
note
Make sure to define the cube_api_base_url and cube_api_key application settings first using the API.

Send query request to Cube

Generate an access token that can be used to query the Cube API. For example: 

POST /projects/:id/product_analytics/request/load POST /projects/:id/product_analytics/request/dry-run
Attribute Type Required Description
id integer yes The ID of a project that the current user has read access to.
include_token boolean no Whether to include the access token in the response. (Only required for funnel generation.)

Request body

The body of the load request must be a valid Cube query.

note
When measuring TrackedEvents, you must use TrackedEvents.* for dimensions and timeDimensions. The same rule applies when measuring Sessions.

Tracked events example 

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

Sessions example 

{ "query": { "measures": [ "Sessions.count" ], "timeDimensions": [ { "dimension": "Sessions.startAt", "granularity": "day" } ], "order": { "Sessions.startAt": "asc" }, "limit": 100 }, "queryType": "multi" }

Send metadata request to Cube

Return Cube Metadata for the Analytics data. For example: 

GET /projects/:id/product_analytics/request/meta
Attribute Type Required Description
id integer yes The ID of a project that the current user has read access to.