Inleiding tot gebruiksexport

De Usage Export API biedt vijf eindpunten om gebruiksgegevens te exporteren voor gebruikers, assistenten, workflows, projecten en modellen uit je workspace. Elk eindpunt retourneert een CSV-bestand met gedetailleerde statistieken voor het geselecteerde datumbereik.

Je kunt ook rechtstreeks in het platform toegang krijgen tot de Usage Export, meer hierover hier: https://docs.langdock.com/admin/usage-exports

Vereisten

Om de Usage Export API te gebruiken, heb je nodig:

  • Workspace-beheerdersmachtiging: Alleen workspace-beheerders kunnen API-sleutels aanmaken met machtigingen voor usage export en gegevens exporteren via de webinterface.

  • API-sleutel met USAGE_EXPORT_API-scope: Speciale toestemming voor toegang tot exportfuncties

Belangrijke beveiligingsmelding: Gebruikers met toegang tot een API-sleutel met USAGE_EXPORT_API-scope kunnen workspace-gebruikgegevens exporteren voor alle gebieden, zelfs als ze normaal gesproken geen toegang hebben om deze gegevens te bekijken. Verleen deze toestemming alleen aan vertrouwde gebruikers.

Programmatechnische export

Beschikbare eindpunten

POST /export/users
POST /export/assistants
POST /export/workflows
POST /export/projects
POST /export/models

Authenticatie

Alle API-aanvragen vereisen Bearer-token authenticatie:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Aanvraagformaat

Tijdspecificatie en tijdzone-afhandeling:

De API gebruikt de exacte tijd die in de datumparameter staat die je aangeeft en behandelt deze als jouw lokale tijden, gespecificeerd in de timezone-parameter. Als je een “Z” aan het einde van je datum opneemt (wat staat voor UTC/Zulu-tijd), wordt deze automatisch verwijderd om te voorkomen dat de tijdzone twee keer wordt toegepast.

Voorbeeld van een request body:

{
  "from": {
    "date": "2024-01-01T00:00:00.000",
    "timezone": "Europe/Berlin"
  },
  "to": {
    "date": "2024-01-31T23:59:59.999",
    "timezone": "UTC"
  }
}

Responsformaat

Succesvolle respons

Datums worden geretourneerd in het juiste tijdzoneformaat met de correcte tijdsverschuiving (bijv. +01:00/+02:00 voor Berlijn).

Voorbeeld van een succesvolle respons:

{
  "success": true,
  "data": {
    "filePath": "assistants-usage/workspace-id/assistants-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.000+01:00",
      "to": "2024-01-31T23:59:59.999"
    }
  }
}

Foutrespons

Voorbeeld van een foutrespons:

{
  "error": "No data found",
  "message": "No usage data found for the selected period"
}

Voorbeeldaanvragen

Exporteer assistentgebruik

curl
curl -X POST "https://api.langdock.com/export/assistants" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": {
      "date": "2024-01-01T00:00:00.000",
      "timezone": "UTC"
    },
    "to": {
      "date": "2024-01-31T23:59:59.999",
      "timezone": "UTC"
    }
  }'

Exporteer gebruikersgebruik

curl
curl -X POST "https://api.langdock.com/export/users" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": {
      "date": "2024-01-01T00:00:00.000",
      "timezone": "UTC"
    },
    "to": {
      "date": "2024-01-31T23:59:59.999",
      "timezone": "UTC"
    }
  }'

Tarieflimieten

  • Tokens per minuut: 60.000 Tokens/Min

  • Aanvragen per minuut: 500 Requests/Min

Limieten voor exportgrootte

  • Exports zijn beperkt tot 1.000.000 rijen. Als je export deze limiet overschrijdt, ontvang je een 400-fout die je vraagt het datumbereik te verkleinen.

Gegevenstypen in detail

Gebruikersexport

Toont individuele gebruikersactiviteit, afhankelijk van privacy-instellingen:

  • Aantal berichten per gebruiker

  • Activiteitspatronen

  • Opmerking: Gebruikersspecifieke gegevens kunnen worden uitgesloten vanwege privacy-instellingen van de workspace

Assistentexport

Bevat gebruiksgegevens voor alle assistenten in de workspace, inclusief:

  • Aantal berichten

  • Actieve gebruikers

  • Gebruikstrends in de tijd

Workflow-export

Gebruiksgegevens voor workflows (indien ingeschakeld):

  • Workflowuitvoeringen

  • Succespercentages

  • Prestatiestatistieken

Projectexport

Projectgerelateerde gebruiksstatistieken:

  • Projectactiviteit

  • Betrokken gebruikers

  • Resourceverbruik

Modelexport

Gedetailleerde informatie over modelgebruik:

  • AI-modellen gebruikt

  • Tokenverbruik

  • Kosten per model

Probleemoplossing

Veelvoorkomende fouten

400 Bad Request - Export te groot

Voorbeeldrespons:

{
  "error": "Export too large",
  "message": "Export too large: 1500000 rows exceeds limit of 1000000. Please narrow the date range."
}

Oplossing: Verminder de tijdsperiode van je aanvraag of splits de export in kleinere tijdsintervallen.

401 Unauthorized

Voorbeeldrespons:

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

Oplossing: Controleer of je API-sleutel correct is en de USAGE_EXPORT_API-machtiging heeft.

404 No Data Found

Voorbeeldrespons:

{
  "error": "No data found",
  "message": "No usage data found for the selected period"
}

Oplossing: Controleer de geselecteerde periode - er kan tijdens deze periode geen activiteit zijn geweest.

Beveiliging en privacy

Privacy-instellingen

Afhankelijk van de workspace-configuratie kunnen bepaalde gegevens worden uitgesloten:

  • Gebruikersidentificerende gegevens: kunnen worden uitgesloten vanwege privacy-instellingen

  • Scorebord (Leaderboards): Moet in de workspace zijn ingeschakeld om volledige gebruikersgegevens te verkrijgen

Best practices

1

Veilige opslag van API-sleutels

Gebruik omgevingsvariabelen of beveiligd sleutelbeheer.

2

Regelmatige rotatie

Vernieuw API-sleutels regelmatig.

3

Minimale machtigingen

Verleen alleen noodzakelijke scopes.

4

Monitoring

Monitor het gebruik van je API-sleutels.

Naleving

De Usage Export API helpt bij nalevingsvereisten:

  • Auditsporen: Volledige tracking van API-gebruik

  • Gegevensexport: Ondersteuning voor GDPR-gegevensrechten

  • Transparantie: Duidelijke inzichten in workspace-gebruik

Ondersteuning

Voor vragen over de Usage Export API, neem contact op met ons supportteam of raadpleeg de volledige API-documentatie.

Gerelateerde links

  • Zoek door alle bestanden in gegevensmappen die gedeeld zijn met de API-sleutel: https://docs.langdock.com/api-endpoints/knowledge-folder/search-knowledge-folder

  • Exporteer gebruikersgebruik: https://docs.langdock.com/api-endpoints/usage-export/export-users

VorigeZoek door alle bestanden in datamappen die worden gedeeld met de API-sleutelVolgendeExporteer gebruikersgebruik