> ## 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.

# Nutzerseitenanalysen abrufen

> Ruft Statistiken zur Nutzeraktivität ab, darunter Namen, E-Mail-Adressen, Zeitpunkte der letzten Aktivität, aktive Tage und verwendete Prompt-Credits auf der Teams-Seite.

<div id="overview">
  ## Überblick
</div>

Rufen Sie Statistiken zur Nutzeraktivität ab, die auf der Teams-Seite angezeigt werden, darunter Nutzernamen, E-Mail-Adressen, Zeitpunkte der letzten Aktivität, aktive Tage und verwendete Prompt-Credits.

<div id="request">
  ## Anfrage
</div>

<ParamField body="service_key" type="string" required>
  Ihr Service-Schlüssel mit den Berechtigungen „Teams Read-only“
</ParamField>

<ParamField body="group_name" type="string">
  Ergebnisse nach Nutzern in einer bestimmten Gruppe filtern (optional)
</ParamField>

<ParamField body="start_timestamp" type="string">
  Startzeitpunkt im RFC-3339-Format (z. B. `2023-01-01T00:00:00Z`). **Wirkt sich nur auf die Berechnung von `activeDays` aus.** Falls nicht angegeben, wird standardmäßig der Zeitpunkt vor 1 Jahr verwendet.
</ParamField>

<ParamField body="end_timestamp" type="string">
  Endzeitpunkt im RFC-3339-Format (z. B. `2023-12-31T23:59:59Z`). **Wirkt sich nur auf die Berechnung von `activeDays` aus.** Falls nicht angegeben, wird standardmäßig die aktuelle Zeit verwendet.
</ParamField>

<div id="example-request">
  ### Beispielanfrage
</div>

```bash theme={null}
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
```

<div id="response">
  ## Antwort
</div>

<ResponseField name="userTableStats" type="array">
  Array aus Objekten mit Nutzerstatistiken

  <Expandable title="Nutzerstatistikobjekt">
    <ResponseField name="name" type="string">
      Anzeigename des Nutzers
    </ResponseField>

    <ResponseField name="email" type="string">
      E-Mail-Adresse des Nutzers
    </ResponseField>

    <ResponseField name="lastUpdateTime" type="string">
      Zeitstempel der letzten Aktivität des Nutzers im RFC-3339-Format
    </ResponseField>

    <ResponseField name="apiKey" type="string">
      Gehashte Version des API-Schlüssels des Nutzers
    </ResponseField>

    <ResponseField name="activeDays" type="number">
      Die Anzahl der Tage, an denen der Nutzer innerhalb des abgefragten Zeitraums aktiv war (definiert durch `start_timestamp` und `end_timestamp`). Ein Tag wird als aktiv gezählt, wenn der Nutzer an diesem Tag angenommene Autocomplete-Vorschläge, Cascade-Nutzung oder Befehlsnutzung hatte.
    </ResponseField>

    <ResponseField name="disableCodeium" type="boolean">
      Gibt an, ob der Zugriff auf Devin Desktop für den Nutzer von einem Admin deaktiviert wurde. Dieses Feld ist nur vorhanden, wenn der Zugriff ausdrücklich deaktiviert wurde, und ist in diesem Fall immer auf true gesetzt.
    </ResponseField>

    <ResponseField name="role" type="string">
      Die Rolle des Nutzers im Team (z. B. Admin, Member)
    </ResponseField>

    <ResponseField name="signupTime" type="string">
      Zeitstempel der Registrierung des Nutzers im RFC-3339-Format
    </ResponseField>

    <ResponseField name="lastAutocompleteUsageTime" type="string">
      Der letzte Zeitstempel, zu dem die Tab-/Autocomplete-Modalität verwendet wurde, im RFC-3339-Format
    </ResponseField>

    <ResponseField name="lastChatUsageTime" type="string">
      Der letzte Zeitstempel, zu dem die Cascade-Modalität verwendet wurde, im RFC-3339-Format
    </ResponseField>

    <ResponseField name="lastCommandUsageTime" type="string">
      Der letzte Zeitstempel, zu dem die Command-Modalität verwendet wurde, im RFC-3339-Format
    </ResponseField>

    <ResponseField name="promptCreditsUsed" type="number">
      Die Gesamtzahl der von diesem Nutzer im **aktuellen Abrechnungszeitraum** verwendeten Prompt-Credits, zurückgegeben in **Cent** (1 Credit = 100 Cent). Um die tatsächliche Nutzung 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 `billingCycleStart` und `billingCycleEnd` auf oberster Ebene angegeben.
    </ResponseField>

    <ResponseField name="teamStatus" type="string">
      Der Status der Teammitgliedschaft des Nutzers. 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 Nutzer unabhängig vom Team-Status zurückgibt, während die UI „Manage Members“ nur genehmigte Nutzer anzeigt.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="billingCycleStart" type="string">
  Der Beginn des aktuellen Abrechnungszeitraums im RFC-3339-Format. Die Werte `promptCreditsUsed` in `userTableStats` entsprechen der Nutzung innerhalb dieses Abrechnungszeitraums.
</ResponseField>

<ResponseField name="billingCycleEnd" type="string">
  Das Ende des aktuellen Abrechnungszeitraums im RFC-3339-Format. Die Werte `promptCreditsUsed` in `userTableStats` entsprechen der Nutzung innerhalb dieses Abrechnungszeitraums.
</ResponseField>

<div id="example-response">
  ### Beispielantwort
</div>

```json theme={null}
{
  "userTableStats": [
    {
      "name": "Alice",
      "email": "alice@cognition.ai",
      "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@cognition.ai",
      "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"
}
```

<div id="error-responses">
  ## Fehlerantworten
</div>

<ResponseField name="error" type="string">
  Fehlermeldung, die beschreibt, was schiefgelaufen ist
</ResponseField>

Häufige Fehlerszenarien:

* Ungültiger Service-Schlüssel oder unzureichende Berechtigungen
* Ungültiges Zeitstempelformat
* Gruppe nicht gefunden
* Rate-Limit überschritten