Skip to main content
POST
Export user usage data
Dieser Endpunkt exportiert Nutzeraktivitätsdaten. Welche identifizierenden Daten enthalten sind, hängt von den Datenschutzeinstellungen deines Workspaces ab.

Bevor du startest

Basis-URL

Dedicated DeploymentsErsetze api.langdock.com durch <your-deployment-url>/api/public in allen Anfragen.

Datenschutzhinweis

Die Einstellung Daten auf User-Ebene steuert, ob nutzerbezogene Detailspalten im Standard-Export enthalten sind. Wenn sie deaktiviert ist, werden die unten gekennzeichneten Spalten ausgelassen, darunter name und email. Zeilen mit group_by=department oder group_by=company_name enthalten den Gruppierungsschlüssel trotzdem und keine Nutzeridentität.

Enthaltene Daten

Standardmäßig gibt der Nutzer-Export eine Zeile pro Nutzer zurück. Ein unbegrenztes payg_limit_current, ein payg_utilization_pct_current ohne positives Limit und ein leeres payg_limit_group_name sind in der JSON-Antwort null. In der CSV bleiben diese Zellen leer. payg_limit_current ist das Extra-Nutzungslimit zum Zeitpunkt des Exports: in EUR in Langdock Cloud Workspaces ohne BYOK, in USD bei BYOK und Dedicated Deployments. payg_consumption_in_period ist die Ausgabe im Zeitraum, gerundet auf zwei Dezimalstellen. Ohne BYOK ist das die Extra-Nutzung in EUR. Ausgaben, die auf das eigene Nutzungslimit eines Agenten gebucht werden, fehlen in diesem Betrag. Bei BYOK und Dedicated Deployments ist es der USD-Betrag jeder Zeile, die auf Nutzungslimits angerechnet wird, auch Ausgaben auf dem eigenen Nutzungslimit eines Agenten. payg_utilization_pct_current ist dieser Verbrauch geteilt durch das aktuelle Limit, gerundet auf vier Dezimalstellen. Das ist ein Verhältnis, kein Prozentwert von 0 bis 100, und der Wert kann größer als 1 sein. Der Wert ist null, wenn das Limit unbegrenzt, 0 oder negativ ist. Bei einem positiven Limit ohne Verbrauch im Zeitraum steht 0. payg_limit_source ist plan, user, group oder workspace. Unter Nutzung und Limits erscheinen sie als Individuell, Workspace sowie Plan oder Gruppe mit dem Namen des Plans oder der Gruppe. Ohne BYOK und mit aktiver Extra-Nutzung gilt standardmäßig das höchste anwendbare Plan- oder Gruppenlimit. Unbegrenzt zählt als höchstes Limit. Bei Gleichstand, auch zwischen zwei unbegrenzten Limits, gewinnt eine Gruppe vor dem Plan und die alphabetisch erste Gruppe vor anderen Gruppen. Ein individuelles Limit mit Individuell oder Unbegrenzt überschreibt es, auch ein Betrag von 0. payg_limit_group_name ist der Name der Gruppe, deren Limit gilt, sonst null. Pro Nutzer gibt es einen Verbrauch, nicht einen pro Gruppe. Ist Extra-Nutzung in Langdock Cloud Workspaces ohne BYOK aus, ist payg_limit_current 0 und payg_limit_source workspace. Bei BYOK und Dedicated Deployments kommt das Limit nur aus der individuellen Extra-Nutzung. Ohne Individuell und ohne Unbegrenzt sind Betrag 0 und Quelle user.

Zusätzliche Spalten für BYOK-Workspaces

Gruppierter Export

Mit group_by=model erhältst du eine Zeile pro Nutzer und Modell. payg_consumption_in_period und payg_utilization_pct_current gelten dann nur für dieses Modell. payg_limit_current, payg_limit_source und payg_limit_group_name wiederholen auf jeder Modellzeile das aktuelle Limit des Nutzers. Zähle payg_limit_current nicht über die Modellzeilen zusammen. Mit group_by=department oder group_by=company_name erhältst du eine Zeile pro Abteilung oder Firmenname. Langdock erfasst Abteilung und Firmenname aus dem Profil, wenn sich ein Nutzer im Workspace anmeldet. Jedes Nutzungsereignis bekommt den zuletzt erfassten Wert zu diesem Zeitpunkt oder davor. Eine Profiländerung, etwa über SCIM, zählt also erst ab der nächsten Anmeldung des Nutzers. Wechselt der Wert später, bleiben der alte und der neue Wert in getrennten Zeilen. Diese Zeilen enthalten keine Nutzeridentität, auch wenn Daten auf User-Ebene aktiviert sind. Eine erfasste leere Abteilung oder ein erfasster leerer Firmenname kommt als No department oder No company zurück, mit attribution_status attributed, sofern sie nicht wie unten beschrieben zusammengefasst wird. Nutzung vor dem ersten erfassten Wert hat einen leeren Gruppierungsschlüssel und attribution_status pre_cutoff. Das gilt auch für aktuelle Nutzung von Nutzern, die sich seit Beginn der Erfassung nicht angemeldet haben. Ohne breakdown enthalten gruppierte Zeilen period_start, period_end, org_id, den Gruppierungsschlüssel, attribution_status, messages_total, messages_chat, messages_assistants, assistants_messaged, messages_projects und active_users. active_users zählt unterschiedliche Nutzer mit einem Prompt im Zeitraum, API-Nutzung eingeschlossen. Cloud-Workspaces ohne BYOK enthalten zusätzlich payg_consumption_in_period, auch wenn Daten auf User-Ebene deaktiviert sind. BYOK-Workspaces und Dedicated Deployments enthalten stattdessen total_input_tokens, total_output_tokens, cached_prompt_tokens, cache_creation_tokens, no_cache_tokens und total_cost_usd. Wenn Daten auf User-Ebene deaktiviert sind, werden zugeordnete Abteilungen oder Firmen mit weniger als 5 aktiven Nutzern zu Combined departments oder Combined companies zusammengefasst. Zeilen mit pre_cutoff bleiben getrennt. Mit breakdown=agent oder breakdown=model zusammen mit group_by=department oder group_by=company_name teilst du jede Gruppe nach Agent oder Modell. Diese Zeilen nutzen messages und active_users statt der Nachrichtenspalten oben, dazu agent_id und agent_name oder model und dieselben Kostenspalten. Agenten-Zeilen umfassen nur Agenten, keine Chats oder Projekte, und Modell-Zeilen zählen auch Bildgenerierung. Die Summe von messages entspricht daher nicht messages_total. Wenn Daten auf User-Ebene deaktiviert sind, werden Agenten oder Modelle mit weniger als 5 aktiven Nutzern in dieser Gruppe zu Combined agents oder Combined models zusammengefasst. Die zusammengefasste Agenten-Zeile hat eine leere agent_id.

Autorisierungen

Authorization
string
header
erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json

Request body for usage export endpoints

from
object
erforderlich

Start date and timezone for the export

to
object
erforderlich

End date and timezone for the export

group_by
enum<string>

Optional aggregation dimension. department and company_name group usage without user identity.

Verfügbare Optionen:
model,
department,
company_name
breakdown
enum<string>

Optional split of a department or company group by agent or model. Valid only when group_by is department or company_name.

Verfügbare Optionen:
agent,
model

Antwort

Export successful

Successful response from usage export endpoints

success
boolean
erforderlich

Indicates if the export was successful

Beispiel:

true

data
object
erforderlich

Export data information