Passer au contenu principal
POST
/
api
/
v1
/
UserPageAnalytics
Obtenir les Analytics de la page Utilisateur
curl --request POST \
  --url https://server.codeium.com/api/v1/UserPageAnalytics \
  --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>"
}

​
Aperçu

Obtenez les statistiques d’activité des utilisateurs affichées sur la page Teams, notamment les noms d’utilisateur, les emails, les heures de dernière activité, les jours d’activité et les crédits de prompt utilisés.

​
Requête

​
service_key
string
requis
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 (optionnel)
​
start_timestamp
string
Horodatage de début au format RFC 3339 (p. ex. : 2023-01-01T00:00:00Z). N’affecte que le calcul de activeDays. S’il n’est pas renseigné, la valeur par défaut est 1 an en arrière.
​
end_timestamp
string
Horodatage de fin au format RFC 3339 (p. ex. : 2023-12-31T23:59:59Z). N’affecte que le calcul de activeDays. S’il n’est pas renseigné, la valeur par défaut est l’heure actuelle.

​
Exemple de demande

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 d’utilisateurs
​
billingCycleStart
string
Début du cycle de facturation actuel au format RFC 3339. Les valeurs promptCreditsUsed dans userTableStats correspondent à l’utilisation au sein de ce cycle de facturation.
​
billingCycleEnd
string
Fin du cycle de facturation actuel au format RFC 3339. Les valeurs promptCreditsUsed dans userTableStats correspondent à l’utilisation au sein de 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 le problème rencontré
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