Récupérer les statistiques de la page utilisateur

curl --request POST \
  --url https://server.codeium.com/api/v1/UserPageAnalytics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "group_name": "<string>",
  "start_timestamp": "<string>",
  "end_timestamp": "<string>"
}
'

{
  "userTableStats": [
    {
      "name": "<string>",
      "email": "<string>",
      "lastUpdateTime": "<string>",
      "apiKey": "<string>",
      "activeDays": 123,
      "disableCodeium": true,
      "role": "<string>",
      "signupTime": "<string>",
      "lastAutocompleteUsageTime": "<string>",
      "lastChatUsageTime": "<string>",
      "lastCommandUsageTime": "<string>",
      "promptCreditsUsed": 123,
      "teamStatus": "<string>"
    }
  ],
  "billingCycleStart": "<string>",
  "billingCycleEnd": "<string>",
  "error": "<string>"
}

POST

api

UserPageAnalytics

Récupérer les statistiques de la page utilisateur

curl --request POST \
  --url https://server.codeium.com/api/v1/UserPageAnalytics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "group_name": "<string>",
  "start_timestamp": "<string>",
  "end_timestamp": "<string>"
}
'

{
  "userTableStats": [
    {
      "name": "<string>",
      "email": "<string>",
      "lastUpdateTime": "<string>",
      "apiKey": "<string>",
      "activeDays": 123,
      "disableCodeium": true,
      "role": "<string>",
      "signupTime": "<string>",
      "lastAutocompleteUsageTime": "<string>",
      "lastChatUsageTime": "<string>",
      "lastCommandUsageTime": "<string>",
      "promptCreditsUsed": 123,
      "teamStatus": "<string>"
    }
  ],
  "billingCycleStart": "<string>",
  "billingCycleEnd": "<string>",
  "error": "<string>"
}

Vue d’ensemble

Récupérez les statistiques d’activité des utilisateurs affichées sur la page Teams, notamment les noms des utilisateurs, leurs adresses e-mail, leurs dernières heures d’activité, leurs jours actifs et les crédits de prompt utilisés.

Requête

service_key

string

requis

Votre clé de service avec les autorisations « Teams en lecture seule »

group_name

string

Limite les résultats aux utilisateurs d’un groupe spécifique (facultatif)

start_timestamp

string

Heure de début au format RFC 3339 (p. ex., 2023-01-01T00:00:00Z). Affecte uniquement le calcul de activeDays. S’il n’est pas fourni, la valeur par défaut est il y a un an.

end_timestamp

string

Heure de fin au format RFC 3339 (p. ex., 2023-12-31T23:59:59Z). Affecte uniquement le calcul de activeDays. S’il n’est pas fourni, l’heure actuelle est utilisée par défaut.

Exemple de requête

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "group_name": "engineering_team",
  "start_timestamp": "2024-01-01T00:00:00Z",
  "end_timestamp": "2024-12-31T23:59:59Z"
}' \
https://server.codeium.com/api/v1/UserPageAnalytics

Réponse

userTableStats

array

Tableau d’objets de statistiques des utilisateurs

Afficher Objet de statistiques utilisateur

name

string

Nom d’affichage de l’utilisateur

string

Adresse e-mail de l’utilisateur

lastUpdateTime

string

Horodatage de la dernière activité de l’utilisateur au format RFC 3339

apiKey

string

Version hachée de la clé API de l’utilisateur

activeDays

number

Nombre de jours pendant lesquels l’utilisateur a été actif dans la plage temporelle demandée (définie par start_timestamp et end_timestamp). Un jour est compté comme actif si l’utilisateur a eu des acceptations d’autocomplétion, une utilisation de Cascade ou une utilisation de Command ce jour-là.

disableCodeium

boolean

Indique si l’accès à Devin Desktop a été désactivé pour l’utilisateur par un admin. Ce champ n’est présent que si l’accès a été explicitement désactivé, et il est alors toujours défini sur true.

role

string

Rôle de l’utilisateur au sein de la Team (p. ex. admin, member)

Horodatage de l’inscription de l’utilisateur, au format RFC 3339

lastAutocompleteUsageTime

string

Horodatage le plus récent d’utilisation du mode Tab/Autocomplete, au format RFC 3339

lastChatUsageTime

string

Horodatage le plus récent d’utilisation du mode Cascade, au format RFC 3339

lastCommandUsageTime

string

Horodatage le plus récent d’utilisation du mode Command, au format RFC 3339

promptCreditsUsed

number

Nombre total de crédits de prompt utilisés par cet utilisateur pendant le cycle de facturation en cours, renvoyé en centimes (1 crédit = 100 centimes). Pour obtenir le nombre réel de crédits utilisés, divisez cette valeur par 100. Cette valeur n’est pas affectée par les paramètres de requête start_timestamp ou end_timestamp. La période du cycle de facturation est indiquée par les champs de niveau supérieur billingCycleStart et billingCycleEnd.

teamStatus

string

Le statut d’appartenance de l’utilisateur à la Team. Valeurs possibles : USER_TEAM_STATUS_UNSPECIFIED, USER_TEAM_STATUS_PENDING, USER_TEAM_STATUS_APPROVED, USER_TEAM_STATUS_REJECTED. Notez que l’API renvoie tous les utilisateurs quel que soit leur statut dans la Team, tandis que l’UI Manage Members n’affiche que les utilisateurs approuvés.

billingCycleStart

string

Début du cycle de facturation en cours au format RFC 3339. Les valeurs promptCreditsUsed dans userTableStats correspondent à l’utilisation pendant ce cycle de facturation.

billingCycleEnd

string

Fin du cycle de facturation en cours au format RFC 3339. Les valeurs promptCreditsUsed dans userTableStats correspondent à l’utilisation pendant ce cycle de facturation.

Exemple de réponse

{
  "userTableStats": [
    {
      "name": "Alice",
      "email": "alice@windsurf.com",
      "lastUpdateTime": "2024-10-10T22:56:10.771591Z",
      "apiKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "activeDays": 178,
      "role": "admin",
      "signupTime": "2024-01-15T08:30:00Z",
      "lastAutocompleteUsageTime": "2024-10-10T22:56:10Z",
      "lastChatUsageTime": "2024-10-10T20:30:00Z",
      "promptCreditsUsed": 12500,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    },
    {
      "name": "Bob",
      "email": "bob@windsurf.com",
      "lastUpdateTime": "2024-10-10T18:11:23.980237Z",
      "apiKey": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "activeDays": 210,
      "role": "member",
      "signupTime": "2024-02-01T10:00:00Z",
      "lastAutocompleteUsageTime": "2024-10-10T18:11:23Z",
      "lastChatUsageTime": "2024-10-09T14:22:00Z",
      "lastCommandUsageTime": "2024-10-08T09:15:00Z",
      "promptCreditsUsed": 8300,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    }
  ],
  "billingCycleStart": "2024-10-01T00:00:00Z",
  "billingCycleEnd": "2024-11-01T00:00:00Z"
}

Réponses d’erreur

error

string

Message d’erreur décrivant l’erreur survenue

Scénarios d’erreur courants :

Clé de service invalide ou autorisations insuffisantes
Format d’horodatage invalide
Groupe introuvable
Limite de requêtes dépassée

API d’analyse Obtenir l’analyse de Cascade

⌘I

Documentation Index

​Vue d’ensemble

​Requête

​Exemple de requête

​Réponse

​Exemple de réponse

​Réponses d’erreur

Vue d’ensemble

Requête

Exemple de requête

Réponse

Exemple de réponse

Réponses d’erreur