Requête Analytics personnalisée

Vue d’ensemble

L’Analytics API personnalisée offre des capacités de requête flexibles pour les données Autocomplete, Chat et Command, avec des selections, des filtres, des aggregations et des tris personnalisables.

Requête

service_key

string

required

Votre clé de service avec l’autorisation “Teams Read-only”

group_name

string

Filtrer les résultats pour les utilisateurs d’un groupe spécifique (facultatif)

query_requests

array

required

Tableau d’objets de requête définissant les données à récupérer

Structure de la requête

Chaque objet de requête contient :

data_source

string

required

Source de données à interroger. Options :

QUERY_DATA_SOURCE_USER_DATA - Données Autocomplete
QUERY_DATA_SOURCE_CHAT_DATA - Données de Chat
QUERY_DATA_SOURCE_COMMAND_DATA - Données de Command
QUERY_DATA_SOURCE_PCW_DATA - Données Percent Code Written

selections

array

required

Tableau de sélections de champs à récupérer (voir la section Selections)

filters

array

Tableau de filtres à appliquer (voir la section Filters)

aggregations

array

Tableau d’aggregations pour le regroupement (voir la section Aggregations)

Selections

Les selections définissent les champs à récupérer et la façon de les agréger.

field

string

required

Nom du champ à sélectionner (voir la section Available Fields)

name

string

Alias du champ. S’il n’est pas spécifié, la valeur par défaut est {aggregation_function}_{field_name} (en minuscules)

aggregation_function

string

Fonction d’agrégation à appliquer :

QUERY_AGGREGATION_UNSPECIFIED (par défaut)
QUERY_AGGREGATION_COUNT
QUERY_AGGREGATION_SUM
QUERY_AGGREGATION_AVG
QUERY_AGGREGATION_MAX
QUERY_AGGREGATION_MIN

Exemple de sélection

{
  "field": "num_acceptances",
  "name": "acceptances_totales",
  "aggregation_function": "QUERY_AGGREGATION_SUM"
}

Filtres

Les filtres limitent les données aux éléments qui répondent à des critères spécifiques.

name

string

required

Nom du champ à filtrer

value

string

required

Valeur de comparaison

filter

string

required

Opération de filtrage :

QUERY_FILTER_EQUAL
QUERY_FILTER_NOT_EQUAL
QUERY_FILTER_GREATER_THAN
QUERY_FILTER_LESS_THAN
QUERY_FILTER_GE (supérieur ou égal)
QUERY_FILTER_LE (inférieur ou égal)

Exemple de filtre

{
  "name": "language",
  "filter": "QUERY_FILTER_EQUAL",
  "value": "PYTHON"
}

Aggregations

Les aggregations regroupent les données selon des critères spécifiés.

field

string

required

Nom du champ utilisé pour le regroupement

name

string

required

Alias du champ d’aggregation

Exemple d’agrégation

{
  "field": "ide",
  "name": "type_ide"
}

Champs disponibles

Données utilisateur

Toutes les données utilisateur sont agrégées par utilisateur et par heure.

Nom du champ	Description	Agrégations valides
`api_key`	Hachage de la clé API de l’utilisateur	UNSPECIFIED, COUNT
`date`	Date UTC de l’Autocompletion	UNSPECIFIED, COUNT
`date UTC-x`	Date avec décalage de fuseau horaire (p. ex. « date UTC-8 » pour PST)	UNSPECIFIED, COUNT
`hour`	Heure UTC de l’Autocompletion	UNSPECIFIED, COUNT
`language`	Langage de programmation	UNSPECIFIED, COUNT
`ide`	IDE utilisé	UNSPECIFIED, COUNT
`version`	Version de Windsurf	UNSPECIFIED, COUNT
`num_acceptances`	Nombre d’acceptations d’Autocomplete	SUM, MAX, MIN, AVG
`num_lines_accepted`	Lignes de code acceptées	SUM, MAX, MIN, AVG
`num_bytes_accepted`	Octets acceptés	SUM, MAX, MIN, AVG
`distinct_users`	Utilisateurs distincts	UNSPECIFIED, COUNT
`distinct_developer_days`	Paires distinctes (utilisateur, jour)	UNSPECIFIED, COUNT
`distinct_developer_hours`	Paires distinctes (utilisateur, heure)	UNSPECIFIED, COUNT

Données de Chat

Toutes les données de Chat correspondent aux réponses du modèle d’IA, et non aux questions des utilisateurs.

Field Name	Description	Valid Aggregations
`api_key`	Hachage de la clé API de l’utilisateur	UNSPECIFIED, COUNT
`model_id`	ID du modèle de Chat	UNSPECIFIED, COUNT
`date`	Date UTC de la réponse du chat	UNSPECIFIED, COUNT
`date UTC-x`	Date avec décalage de fuseau horaire	UNSPECIFIED, COUNT
`ide`	IDE utilisé	UNSPECIFIED, COUNT
`version`	Version de Windsurf	UNSPECIFIED, COUNT
`latest_intent_type`	Type d’intention du Chat (voir Types d’intention ci‑dessous)	UNSPECIFIED, COUNT
`num_chats_received`	Nombre de messages de chat reçus	SUM, MAX, MIN, AVG
`chat_accepted`	Indique si le chat a été accepté (pouce levé)	SUM, COUNT
`chat_inserted_at_cursor`	Indique si le bouton « Insert » a été cliqué	SUM, COUNT
`chat_applied`	Indique si le bouton « Apply Diff » a été cliqué	SUM, COUNT
`chat_loc_used`	Lignes de code utilisées à partir du chat	SUM, MAX, MIN, AVG

Types d’intentions de Chat

CHAT_INTENT_GENERIC - Chat classique
CHAT_INTENT_FUNCTION_EXPLAIN - CodeLens d’explication de fonction
CHAT_INTENT_FUNCTION_DOCSTRING - CodeLens de docstring de fonction
CHAT_INTENT_FUNCTION_REFACTOR - CodeLens de refactorisation de fonction
CHAT_INTENT_CODE_BLOCK_EXPLAIN - CodeLens d’explication de bloc de code
CHAT_INTENT_CODE_BLOCK_REFACTOR - CodeLens de refactorisation de bloc de code
CHAT_INTENT_PROBLEM_EXPLAIN - CodeLens d’explication de problème
CHAT_INTENT_FUNCTION_UNIT_TESTS - CodeLens de tests unitaires de fonction

Données de Command

Les données de Command incluent toutes les commandes, y compris celles refusées. Utilisez le champ accepted pour filtrer uniquement les commandes acceptées.

Nom du champ	Description	Agrégations valides
`api_key`	Hachage de la clé API de l’utilisateur	UNSPECIFIED, COUNT
`date`	Date UTC de la commande	UNSPECIFIED, COUNT
`timestamp`	Horodatage UTC de la commande	UNSPECIFIED, COUNT
`language`	Langage de programmation	UNSPECIFIED, COUNT
`ide`	IDE utilisé	UNSPECIFIED, COUNT
`version`	Version de Windsurf	UNSPECIFIED, COUNT
`command_source`	Source de déclenchement de Command (voir Command Sources ci-dessous)	UNSPECIFIED, COUNT
`provider_source`	Mode de génération ou d’édition	UNSPECIFIED, COUNT
`lines_added`	Lignes de code ajoutées	SUM, MAX, MIN, AVG
`lines_removed`	Lignes de code supprimées	SUM, MAX, MIN, AVG
`bytes_added`	Octets ajoutés	SUM, MAX, MIN, AVG
`bytes_removed`	Octets supprimés	SUM, MAX, MIN, AVG
`selection_lines`	Lignes sélectionnées (zéro pour les générations)	SUM, MAX, MIN, AVG
`selection_bytes`	Octets sélectionnés (zéro pour les générations)	SUM, MAX, MIN, AVG
`accepted`	Indique si la commande a été acceptée	SUM, COUNT

Sources de Command

COMMAND_REQUEST_SOURCE_LINE_HINT_CODE_LENS
COMMAND_REQUEST_SOURCE_DEFAULT - Utilisation typique de Command
COMMAND_REQUEST_SOURCE_RIGHT_CLICK_REFACTOR
COMMAND_REQUEST_SOURCE_FUNCTION_CODE_LENS
COMMAND_REQUEST_SOURCE_FOLLOWUP
COMMAND_REQUEST_SOURCE_CLASS_CODE_LENS
COMMAND_REQUEST_SOURCE_PLAN
COMMAND_REQUEST_SOURCE_SELECTION_HINT_CODE_LENS

Sources du fournisseur

PROVIDER_SOURCE_COMMAND_GENERATE - Mode génération
PROVIDER_SOURCE_COMMAND_EDIT - Mode édition

Données PCW

Données « Percent Code Written » avec un suivi distinct des contributions d’Autocomplete et de Command.

Nom du champ	Description	Agrégations valides
`percent_code_written`	Calculé comme codeium_bytes / (codeium_bytes + user_bytes)	UNSPECIFIED
`codeium_bytes`	Nombre total d’octets générés par Codeium	UNSPECIFIED
`user_bytes`	Nombre total d’octets écrits par l’utilisateur	UNSPECIFIED
`total_bytes`	codeium_bytes + user_bytes	UNSPECIFIED
`codeium_bytes_by_autocomplete`	Octets Codeium issus d’Autocomplete	UNSPECIFIED
`codeium_bytes_by_command`	Octets Codeium issus de Command	UNSPECIFIED

Filtres PCW

Nom du champ	Description	Exemples
`language`	Langage de programmation	KOTLIN, GO, JAVA
`ide`	IDE utilisé	jetbrains, vscode
`version`	Version de Windsurf	1.28.0, 130.0

Pour filtrer par date dans les requêtes PCW, utilisez start_timestamp et end_timestamp dans le corps principal de la requête.

Exemples de demandes

Exemple de données utilisateur

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "votre_cle_de_service_ici",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_USER_DATA",
      "selections": [
        {
          "field": "num_acceptances",
          "name": "acceptations_totales",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        },
        {
          "field": "num_lines_accepted",
          "name": "lignes_totales",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        }
      ],
      "filters": [
        {
          "name": "hour",
          "filter": "QUERY_FILTER_GE",
          "value": "2024-01-01"
        },
        {
          "name": "hour",
          "filter": "QUERY_FILTER_LE",
          "value": "2024-02-01"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Exemple de données de Chat

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "votre_service_key_ici",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_CHAT_DATA",
      "selections": [
        {
          "field": "chat_loc_used",
          "name": "lignes_utilisees",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        }
      ],
      "filters": [
        {
          "name": "latest_intent_type",
          "filter": "QUERY_FILTER_EQUAL",
          "value": "CHAT_INTENT_FUNCTION_DOCSTRING"
        }
      ],
      "aggregations": [
        {
          "field": "ide",
          "name": "type_ide"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Exemple de données de Command

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "votre_cle_de_service_ici",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_COMMAND_DATA",
      "selections": [
        {
          "field": "lines_added",
          "name": "total_lignes_ajoutees",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        },
        {
          "field": "lines_removed",
          "name": "total_lignes_supprimees",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        }
      ],
      "filters": [
        {
          "name": "provider_source",
          "filter": "QUERY_FILTER_EQUAL",
          "value": "PROVIDER_SOURCE_COMMAND_EDIT"
        },
        {
          "name": "accepted",
          "filter": "QUERY_FILTER_EQUAL",
          "value": "true"
        }
      ],
      "aggregations": [
        {
          "field": "language",
          "name": "langage_de_programmation"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Exemple de données PCW

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "votre_service_key_ici",
  "start_timestamp": "2024-01-01T00:00:00Z",
  "end_timestamp": "2024-12-22T00:00:00Z",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_PCW_DATA",
      "selections": [
        {
          "field": "percent_code_written",
          "name": "pcw"
        },
        {
          "field": "codeium_bytes",
          "name": "ai_bytes"
        },
        {
          "field": "total_bytes",
          "name": "total"
        },
        {
          "field": "codeium_bytes_by_autocomplete",
          "name": "autocomplete_bytes"
        },
        {
          "field": "codeium_bytes_by_command",
          "name": "command_bytes"
        }
      ],
      "filters": [
        {
          "filter": "QUERY_FILTER_EQUAL",
          "name": "language",
          "value": "GO"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Réponse

queryResults

array

Tableau de résultats de requête, un par requête

responseItems

array

Tableau d’éléments de résultat

item

object

Objet contenant les champs sélectionnés et leurs valeurs

Exemples de réponses

Réponse de données de l’utilisateur

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "total_acceptances": "125",
            "total_lines": "863"
          }
        }
      ]
    }
  ]
}

Réponse de données du Chat

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "lines_used": "74",
            "ide_type": "jetbrains"
          }
        },
        {
          "item": {
            "lines_used": "41",
            "ide_type": "vscode"
          }
        }
      ]
    }
  ]
}

Réponse de données de Command

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "programming_language": "PYTHON",
            "total_lines_added": "21",
            "total_lines_removed": "5"
          }
        },
        {
          "item": {
            "programming_language": "GO",
            "total_lines_added": "31",
            "total_lines_removed": "27"
          }
        }
      ]
    }
  ]
}

Réponse de données PCW

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "ai_bytes": "6018",
            "autocomplete_bytes": "4593",
            "command_bytes": "1425",
            "pcw": "0.61",
            "total": "9900"
          }
        }
      ]
    }
  ]
}

Notes importantes

Le PCW (Percent Code Written) peut fortement varier au cours d’une même journée ou d’un même utilisateur — regroupez par semaines pour des analyses plus pertinentes
Tous les champs de sélection doivent soit tous avoir des fonctions d’agrégation, soit aucun (pas de mélange possible)
Les champs correspondant au motif “distinct_*” ne peuvent pas être utilisés dans des aggregations
Les alias de champs doivent être uniques dans l’ensemble des selections et aggregations
Si aucune fonction d’agrégation n’est spécifiée, la valeur par défaut est UNSPECIFIED

Bien démarrer

Fonctionnalités

Cascade (JetBrains)

Comptes

Sensibilité au contexte

Bonnes pratiques

Dépannage

Sécurité

Requête Analytics personnalisée

Vue d’ensemble

Requête

Structure de la requête

Selections

Exemple de sélection

Filtres

Exemple de filtre

Aggregations

Exemple d’agrégation

Champs disponibles

Données utilisateur

Données de Chat

Types d’intentions de Chat

Données de Command

Sources de Command

Sources du fournisseur

Données PCW

Filtres PCW

Exemples de demandes

Exemple de données utilisateur

Exemple de données de Chat

Exemple de données de Command

Exemple de données PCW

Réponse

Exemples de réponses

Réponse de données de l’utilisateur

Réponse de données du Chat

Réponse de données de Command

Réponse de données PCW

Notes importantes

Bien démarrer

Fonctionnalités

Cascade (JetBrains)

Comptes

Sensibilité au contexte

Bonnes pratiques

Dépannage

Sécurité

​Vue d’ensemble

​Requête

​Structure de la requête

​Selections

​Exemple de sélection

​Filtres

​Exemple de filtre

​Aggregations

​Exemple d’agrégation

​Champs disponibles

​Données utilisateur

​Données de Chat

​Types d’intentions de Chat

​Données de Command

​Sources de Command

​Sources du fournisseur

​Données PCW

​Filtres PCW

​Exemples de demandes

​Exemple de données utilisateur

​Exemple de données de Chat

​Exemple de données de Command

​Exemple de données PCW

​Réponse

​Exemples de réponses

​Réponse de données de l’utilisateur

​Réponse de données du Chat

​Réponse de données de Command

​Réponse de données PCW

​Notes importantes

Vue d’ensemble

Requête

Structure de la requête

Selections

Exemple de sélection

Filtres

Exemple de filtre

Aggregations

Exemple d’agrégation

Champs disponibles

Données utilisateur

Données de Chat

Types d’intentions de Chat

Données de Command

Sources de Command

Sources du fournisseur

Données PCW

Filtres PCW

Exemples de demandes

Exemple de données utilisateur

Exemple de données de Chat

Exemple de données de Command

Exemple de données PCW

Réponse

Exemples de réponses

Réponse de données de l’utilisateur

Réponse de données du Chat

Réponse de données de Command

Réponse de données PCW

Notes importantes