Saltar al contenido principal
POST
https://server.codeium.com
/
api
/
v1
/
UserPageAnalytics
Obtener Analytics de la página de usuario
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,
      "lastAutocompleteUsageTime": "<string>",
      "lastChatUsageTime": "<string>",
      "lastCommandUsageTime": "<string>"
    }
  ],
  "error": "<string>"
}

​
Descripción general

Obtén estadísticas de actividad de usuarios que aparecen en la página de Teams, incluidos los nombres de usuario, emails, la hora de la última actividad y los días activos.

​
Solicitud

​
service_key
string
requerido
Tu clave de servicio con permisos “Teams Read-only”
​
group_name
string
Filtra los resultados a los usuarios de un grupo específico (opcional)
​
start_timestamp
string
Hora de inicio en formato RFC 3339 (p. ej., 2023-01-01T00:00:00Z)
​
end_timestamp
string
Hora de finalización en formato RFC 3339 (p. ej., 2023-12-31T23:59:59Z)

​
Ejemplo de solicitud

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

​
Respuesta

​
userTableStats
array
Arreglo de objetos de estadísticas de usuarios

​
Ejemplo de respuesta

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

​
Respuestas de error

​
error
string
Mensaje de error que describe qué salió mal
Escenarios de error comunes:
  • Clave de servicio inválida o permisos insuficientes
  • Formato de marca de tiempo inválido
  • Grupo no encontrado
  • Se superó el límite de solicitudes