API Product Analytics

{{< details >}}

• Édition : GitLab Ultimate
• Offre : GitLab.com, GitLab Self-Managed
• Statut : Bêta

{{< /details >}}

{{< history >}}

• Introduit dans GitLab 15.4 avec un indicateur nommé cube_api_proxy. Désactivé par défaut.
• cube_api_proxy supprimé et remplacé par product_analytics_internal_preview dans GitLab 15.10.
• product_analytics_internal_preview remplacé par product_analytics_dashboards dans GitLab 15.11.
• product_analytics_dashboards activé par défaut dans GitLab 16.11.
• Le feature flag product_analytics_dashboards supprimé dans GitLab 17.1.
• Modifié en bêta dans GitLab 17.5 avec un indicateur nommé product_analytics_features.

{{< /history >}}

[!flag] La disponibilité de cette fonctionnalité est contrôlée par un feature flag. Pour plus d'informations, consultez l'historique. Cette fonctionnalité n'est pas prête pour une utilisation en production.

Utilisez cette API pour suivre le comportement des utilisateurs et l'utilisation des applications.

[!note] Assurez-vous de définir d'abord les paramètres d'application cube_api_base_url et cube_api_key en utilisant l'API.

Créer une requête Cube {#create-a-cube-query-request}

Crée une requête vers l'API Cube et génère un jeton d'accès.

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

Corps de la requête {#request-body}

Le corps de la requête de chargement doit être une requête Cube valide.

[!note] Lors de la mesure de TrackedEvents, vous devez utiliser TrackedEvents.* pour dimensions et timeDimensions. La même règle s'applique lors de la mesure de Sessions.

Exemple d'événements suivis {#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"
}

Exemple de sessions {#sessions-example}

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

Récupérer les métadonnées Cube {#retrieve-cube-metadata}

Récupère les métadonnées Cube pour les données d'analyse.

GET /projects/:id/product_analytics/request/meta