Seiten-Analytics für Benutzer abrufen

Statistiken zur Benutzeraktivität, einschließlich Namen, emails, Zeitpunkten der letzten Aktivität, aktiven Tagen und verwendeten prompt credits, von der Teams-Seite abrufen.

POST /api/v1/UserPageAnalytics

Seiten-Analytics für Benutzer abrufen

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,
      "role": "<string>",
      "signupTime": "<string>",
      "lastAutocompleteUsageTime": "<string>",
      "lastChatUsageTime": "<string>",
      "lastCommandUsageTime": "<string>",
      "promptCreditsUsed": 123,
      "teamStatus": "<string>"
    }
  ],
  "billingCycleStart": "<string>",
  "billingCycleEnd": "<string>",
  "error": "<string>"
}

​

Übersicht

Rufen Sie die auf der Teams-Seite angezeigten Nutzeraktivitätsstatistiken ab, einschließlich Benutzernamen, emails, Zeitpunkt der letzten Aktivität, aktiver Tage und verbrauchter prompt credits.

​

Anfrage

service_key · string · erforderlich

Ihr Service Key mit „Teams Nur-Lesen“-Berechtigungen

group_name · string

Ergebnisse auf Benutzer in einer bestimmten Gruppe filtern (optional)

start_timestamp · string

Startzeit im RFC 3339-Format (z. B. 2023-01-01T00:00:00Z). Beeinflusst nur die Berechnung von activeDays. Wenn nicht angegeben, wird standardmäßig der Zeitpunkt vor einem Jahr verwendet.

end_timestamp · string

Endzeit im RFC 3339-Format (z. B. 2023-12-31T23:59:59Z). Beeinflusst nur die Berechnung von activeDays. Wenn nicht angegeben, wird standardmäßig die aktuelle Zeit verwendet.

​

Beispielanfrage

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

​

Response

userTableStats · array

Array von Objekten mit Benutzerstatistiken

Anzeigen Benutzerstatistik-Objekt

name · string

Anzeigename des Benutzers

email · string

E-Mail-Adresse des Benutzers

lastUpdateTime · string

Zeitstempel der letzten Aktivität des Benutzers im RFC 3339-Format

apiKey · string

Gehashte Version des API-Schlüssels des Benutzers

activeDays · number

Die Anzahl der Tage, an denen der Benutzer im abgefragten Zeitraum (definiert durch start_timestamp und end_timestamp) aktiv war. Ein Tag wird als aktiv gezählt, wenn der Benutzer an diesem Tag mindestens eine Autocomplete-Annahme, Cascade-Nutzung oder Command-Nutzung hatte.

disableCodeium · boolean

Gibt an, ob der Windsurf-Zugriff für den Benutzer von einem Admin deaktiviert wurde. Dieses Feld ist nur vorhanden, wenn der Zugriff explizit deaktiviert wurde, und ist in diesem Fall immer auf true gesetzt.

role · string

Die Rolle des Benutzers innerhalb des Teams (z. B. admin, member)

signupTime · string

Zeitstempel der Registrierung des Benutzers im RFC 3339-Format

lastAutocompleteUsageTime · string

Der aktuellste Zeitstempel, zu dem die Tab-/Autocomplete-Modalität verwendet wurde, im RFC 3339-Format

lastChatUsageTime · string

Der aktuellste Zeitstempel, zu dem die Cascade-Modalität verwendet wurde, im RFC 3339-Format

lastCommandUsageTime · string

Der aktuellste Zeitstempel, zu dem die Command-Modalität verwendet wurde, im RFC 3339-Format

promptCreditsUsed · number

Die Gesamtzahl der prompt credits, die von diesem Benutzer während des aktuellen Abrechnungszeitraums verwendet wurden, zurückgegeben als Cent-Betrag (1 credit = 100 Cent). Um die tatsächliche Anzahl der Credits zu erhalten, teilen Sie diesen Wert durch 100. Dieser Wert wird nicht von den Request-Parametern start_timestamp oder end_timestamp beeinflusst. Das Zeitfenster des Abrechnungszeitraums wird durch die Felder auf oberster Ebene billingCycleStart und billingCycleEnd angegeben.

teamStatus · string

Der Teammitgliedschaftsstatus des Benutzers. Mögliche Werte: USER_TEAM_STATUS_UNSPECIFIED, USER_TEAM_STATUS_PENDING, USER_TEAM_STATUS_APPROVED, USER_TEAM_STATUS_REJECTED. Beachten Sie, dass die API alle Benutzer unabhängig vom Teamstatus zurückgibt, während die „Manage Members“-UI nur genehmigte Benutzer anzeigt.

billingCycleStart · string

Der Beginn des aktuellen Abrechnungszeitraums im RFC 3339-Format. Die promptCreditsUsed-Werte in userTableStats entsprechen der Nutzung innerhalb dieses Abrechnungszeitraums.

billingCycleEnd · string

Das Ende des aktuellen Abrechnungszeitraums im RFC 3339-Format. Die promptCreditsUsed-Werte in userTableStats entsprechen der Nutzung innerhalb dieses Abrechnungszeitraums.

​

Beispielantwort

{
  "userTableStats": [
    {
      "name": "Alice",
      "email": "[e-mail]",
      "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": "[e-mail]",
      "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"
}

​

Fehlerantworten

error · string

Fehlermeldung, die beschreibt, was falsch gelaufen ist

Häufige Fehlerszenarien:

• Ungültiger Service Key oder unzureichende Berechtigungen
• Ungültiges Zeitstempelformat
• Gruppe nicht gefunden
• Anfragelimit überschritten