Obtenir les Analytics de la page Utilisateur

Récupérer les statistiques d’activité des utilisateurs, notamment les noms, adresses e-mail, dates de dernière activité et jours d’activité, à partir de la page Teams.

POST /api/v1/UserPageAnalytics

Obtenir les Analytics de la page Utilisateur

cURL

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

200

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

​

Aperçu

Obtenez les statistiques d’activité des utilisateurs affichées sur la page Teams, notamment les noms, les emails, les dernières activités et les jours d’activité.

​

Requête

service_key · string · requis

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

group_name · string

Filtrer 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)

end_timestamp · string

Heure de fin au format RFC 3339 (p. ex. : 2023-12-31T23:59:59Z)

​

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 utilisateur

Afficher Objet de statistiques utilisateur

name · string

Nom d’affichage de l’utilisateur

email · 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 total de jours pendant lesquels l’utilisateur a été actif sur la période demandée

disableCodeium · boolean

Indique si l’accès à Windsurf a été désactivé pour l’utilisateur par un administrateur. Ce champ n’est présent que si l’accès a été explicitement désactivé, et aura alors toujours la valeur true.

lastAutocompleteUsageTime · string

Horodatage le plus récent auquel le mode Tab/Autocomplete a été utilisé, au format RFC 3339

lastChatUsageTime · string

Horodatage le plus récent auquel le mode Cascade a été utilisé, au format RFC 3339

lastCommandUsageTime · string

Horodatage le plus récent auquel le mode Command a été utilisé, au format RFC 3339

teamStatus · string

Statut d’appartenance de l’utilisateur à l’équipe. 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 d’équipe, tandis que l’interface Manage Members n’affiche que les utilisateurs approuvés.

​

Exemple de réponse

{
  "userTableStats": [
    {
      "name": "Alice",
      "email": "[e-mail]",
      "lastUpdateTime": "2024-10-10T22:56:10.771591Z",
      "apiKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "activeDays": 178,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    },
    {
      "name": "Bob",
      "email": "[e-mail]",
      "lastUpdateTime": "2024-10-10T18:11:23.980237Z",
      "apiKey": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "activeDays": 462,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    },
    {
      "name": "Charlie",
      "email": "[e-mail]",
      "lastUpdateTime": "2024-10-10T16:43:46.117870Z",
      "apiKey": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "activeDays": 237,
      "teamStatus": "USER_TEAM_STATUS_PENDING"
    }
  ]
}

​

Réponses d’erreur

error · string

Message d’erreur décrivant ce qui s’est produit

Scénarios d’erreur courants :

• Clé de service invalide ou autorisations insuffisantes
• Format d’horodatage invalide
• Groupe introuvable
• Limite de débit dépassée