Vai al contenuto principale
POST
/
api
/
v1
/
UserPageAnalytics
Recupera le statistiche della pagina utenti
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.devin.ai/llms.txt

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

​
Panoramica

Recupera le statistiche sull’attività degli utenti presenti nella pagina Teams, inclusi nomi degli utenti, email, orari dell’ultima attività, giorni attivi e crediti prompt utilizzati.

​
Richiesta

​
service_key
string
obbligatorio
La tua chiave di servizio con autorizzazioni “Teams sola lettura”
​
group_name
string
Filtra i risultati per gli utenti di un gruppo specifico (facoltativo)
​
start_timestamp
string
Timestamp iniziale nel formato RFC 3339 (ad es. 2023-01-01T00:00:00Z). Influisce solo sul calcolo di activeDays. Se non viene fornito, il valore predefinito è 1 anno fa.
​
end_timestamp
string
Timestamp finale nel formato RFC 3339 (ad es. 2023-12-31T23:59:59Z). Influisce solo sul calcolo di activeDays. Se non viene fornito, il valore predefinito è l’ora corrente.

​
Esempio di richiesta

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

​
Risposta

​
userTableStats
array
Array di oggetti contenenti statistiche sugli utenti
​
billingCycleStart
string
Inizio del ciclo di fatturazione corrente in formato RFC 3339. I valori promptCreditsUsed in userTableStats corrispondono all’utilizzo in questo ciclo di fatturazione.
​
billingCycleEnd
string
Fine del ciclo di fatturazione corrente in formato RFC 3339. I valori promptCreditsUsed in userTableStats corrispondono all’utilizzo in questo ciclo di fatturazione.

​
Esempio di risposta

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

​
Risposte di errore

​
error
string
Messaggio di errore che descrive il problema
Scenari di errore comuni:
  • Chiave di servizio non valida o autorizzazioni insufficienti
  • Formato del timestamp non valido
  • Gruppo non trovato
  • Limite di richieste superato