Zum Hauptinhalt springen
POST
/
export
/
users
Export user usage data
curl --request POST \
  --url https://api.langdock.com/export/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": {
    "date": "2024-01-01T00:00:00.000Z",
    "timezone": "UTC"
  },
  "to": {
    "date": "2024-01-31T23:59:59.999Z",
    "timezone": "UTC"
  },
  "group_by": "model"
}
'
import requests

url = "https://api.langdock.com/export/users"

payload = {
"from": {
"date": "2024-01-01T00:00:00.000Z",
"timezone": "UTC"
},
"to": {
"date": "2024-01-31T23:59:59.999Z",
"timezone": "UTC"
},
"group_by": "model"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from: {date: '2024-01-01T00:00:00.000Z', timezone: 'UTC'},
to: {date: '2024-01-31T23:59:59.999Z', timezone: 'UTC'},
group_by: 'model'
})
};

fetch('https://api.langdock.com/export/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.langdock.com/export/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from' => [
'date' => '2024-01-01T00:00:00.000Z',
'timezone' => 'UTC'
],
'to' => [
'date' => '2024-01-31T23:59:59.999Z',
'timezone' => 'UTC'
],
'group_by' => 'model'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.langdock.com/export/users"

payload := strings.NewReader("{\n \"from\": {\n \"date\": \"2024-01-01T00:00:00.000Z\",\n \"timezone\": \"UTC\"\n },\n \"to\": {\n \"date\": \"2024-01-31T23:59:59.999Z\",\n \"timezone\": \"UTC\"\n },\n \"group_by\": \"model\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.langdock.com/export/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from\": {\n \"date\": \"2024-01-01T00:00:00.000Z\",\n \"timezone\": \"UTC\"\n },\n \"to\": {\n \"date\": \"2024-01-31T23:59:59.999Z\",\n \"timezone\": \"UTC\"\n },\n \"group_by\": \"model\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.langdock.com/export/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": {\n \"date\": \"2024-01-01T00:00:00.000Z\",\n \"timezone\": \"UTC\"\n },\n \"to\": {\n \"date\": \"2024-01-31T23:59:59.999Z\",\n \"timezone\": \"UTC\"\n },\n \"group_by\": \"model\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "filePath": "agents-usage/workspace-id/agents-usage-2024-01-01-2024-01-31-abc12345.csv",
    "downloadUrl": "https://storage.example.com/signed-url",
    "dataType": "assistants",
    "recordCount": 1250,
    "dateRange": {
      "from": "2024-01-01T00:00:00.000Z",
      "to": "2024-01-31T23:59:59.999Z"
    }
  }
}
{
"error": "No data found",
"message": "No usage data found for the selected period"
}
{
"error": "No data found",
"message": "No usage data found for the selected period"
}
{
"error": "No data found",
"message": "No usage data found for the selected period"
}
Dieser Endpunkt exportiert Nutzeraktivitätsdaten. Welche identifizierenden Daten enthalten sind, hängt von den Datenschutzeinstellungen deines Workspaces ab.
Dedicated Deployment?Ersetze api.langdock.com durch <your-deployment>/api/public in allen Anfragen.
Details zu Voraussetzungen und Rate Limits findest du in der Hauptdokumentation zur Usage Export API.
Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen. Verwende API-Schlüssel serverseitig und speichere sie sicher. Mehr dazu findest du unter Best Practices für API-Schlüssel.

Datenschutzhinweis

Wenn Daten auf Nutzerebene im Workspace deaktiviert sind, werden identifizierende Spalten wie Name und E-Mail aus dem Export ausgeschlossen.

Enthaltene Daten

Standardmäßig gibt der Nutzer-Export eine Zeile pro Nutzer zurück.
SpalteBeschreibung
period_startStartdatum des Berichts
period_endEnddatum des Berichts
org_idID des Workspaces
user_idID des Nutzers
nameName des Nutzers
emailE-Mail des Nutzers
roleRolle des Nutzers
joined_atDatum des Workspace-Beitritts
departmentAbteilung
company_nameFirmenname
license_typeAktuelle Lizenzstufe
payg_limit_currentAktuelles Extra-Usage-Limit
payg_consumption_in_periodExtra-Usage-Verbrauch im Zeitraum
payg_utilization_pct_currentpayg_consumption_in_period / payg_limit_current
messages_totalGesamtzahl der Nachrichten
messages_total_rankRang nach Gesamtnachrichten
messages_chatNachrichten in normalen Chats
messages_chat_rankRang nach Chat-Nachrichten
messages_assistantsNachrichten an Agenten
messages_assistants_rankRang nach Agenten-Nachrichten
assistants_messagedAnzahl unterschiedlicher Agenten
assistants_to_messagesJSON-Zuordnung von Agent-ID zu Nachrichtenanzahl
messages_projectsNachrichten in Projekten
messages_projects_rankRang nach Projekt-Nachrichten
projects_messagedAnzahl unterschiedlicher Projekte
projects_to_messagesJSON-Zuordnung von Projekt-ID zu Nachrichtenanzahl
model_to_messages_totalJSON-Zuordnung von Modellname zu Nachrichtenanzahl
action_messagesDurch Aktionen erzeugte Nachrichten
action_messagedAnzahl unterschiedlicher ausgelöster Aktionen
action_to_messagesJSON-Zuordnung von Aktionsname zu Nachrichtenanzahl

Zusätzliche Spalten für BYOK-Workspaces

SpalteBeschreibung
total_input_tokensGesamte Input-Tokens
total_output_tokensGesamte Output-Tokens
cached_prompt_tokensCache-Read-Input-Tokens
cache_creation_tokensCache-Write-Input-Tokens
no_cache_tokensInput-Tokens, die nicht aus dem Cache kamen
total_cost_usdGeschätzte Provider-Kosten in USD

Gruppierter Export

Mit group_by=model erhältst du eine Zeile pro Nutzer und Modell.

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.

Verfügbare Optionen:
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