Saltar al contenido principal
POST
/
api
/
v1
/
UserPageAnalytics
Obtener estadísticas de la página de usuarios
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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.devinenterprise.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Información general

Obtén las estadísticas de actividad de los usuarios que aparecen en la página de Teams, incluidos sus nombres, correos electrónicos, horas de la última actividad, días activos y créditos de prompt utilizados.

​
Solicitud

​
service_key
string
requerido
Tu clave de servicio con permisos “Teams Read-only”
​
group_name
string
Filtra los resultados para mostrar solo 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). Solo afecta al cálculo de activeDays. Si no se proporciona, por defecto se usa hace 1 año.
​
end_timestamp
string
Hora de finalización en formato RFC 3339 (p. ej., 2023-12-31T23:59:59Z). Solo afecta al cálculo de activeDays. Si no se proporciona, por defecto se usa la hora actual.

​
Solicitud de ejemplo

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
Array de objetos de estadísticas de usuarios
​
billingCycleStart
string
El inicio del ciclo de facturación actual en formato RFC 3339. Los valores de promptCreditsUsed en userTableStats corresponden al uso dentro de este ciclo de facturación.
​
billingCycleEnd
string
El final del ciclo de facturación actual en formato RFC 3339. Los valores de promptCreditsUsed en userTableStats corresponden al uso dentro de este ciclo de facturación.

​
Respuesta de ejemplo

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

​
Respuestas de error

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