Exporteer gebruikersgebruik

Dit eindpunt exporteert gebruikersactiviteitsgegevens inclusief berichtenaantallen, gebruikspatronen en functiebenutting. De beschikbare gegevens hangen af van de privacy-instellingen van uw workspace.

POST https://api.langdock.com/export/users

Probeer het

Voorbeeldverzoek (cURL)

curl --request POST \
  --url https://api.langdock.com/export/users \
  --header 'Authorization: <authorization>' \
  --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"
  }
}
'

Voorbeeldantwoord (200)

{
  "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.000Z",
      "to": "2024-01-31T23:59:59.999Z"
    }
  }
}

Statuscodes: 200, 400, 401, 404


Privacyoverwegingen

De gebruikersexportgegevens zijn onderhevig aan de privacy-instellingen van de workspace. Gebruikersidentificerende gegevens kunnen worden uitgesloten vanwege privacy-instellingen. Als gevolg hiervan kunnen sommige gegevens worden geanonimiseerd op basis van de workspace-configuratie.


Opgenomen gegevens

De gebruikersexport kan bevatten:

  • Aantal berichten per gebruiker

  • Activiteitspatronen

  • Gebruikfrequentie

  • Functiebenutting

  • Tijdgebaseerde gebruiksanalyses

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

Aanvullende informatie (vereisten, snelheidslimieten, limieten voor exportgrootte): zie de hoofddocumentatie van de Usage Export API: https://docs.langdock.com/api-endpoints/usage-export/intro-to-usage-export-api


Headers

Autorisatie (string, vereist) API-sleutel als Bearer-token met USAGE_EXPORT_API-scope. Formaat: "Bearer YOUR_API_KEY"

Content-Type: application/json


Body (application/json)

Request-body voor gebruiksexport-eindpunten.

from (object, vereist) — Startdatum en tijdzone voor de export

  • from.date (string, vereist) — Begindatum in ISO 8601-formaat Voorbeeld: "2024-01-01T00:00:00.000Z"

  • from.timezone (string, vereist) — Tijdzone voor het datumbereik Voorbeeld: "UTC"

to (object, vereist) — Einddatum en tijdzone voor de export

  • to.date (string, vereist) — Einddatum in ISO 8601-formaat Voorbeeld: "2024-01-31T23:59:59.999Z"

  • to.timezone (string, vereist) — Tijdzone voor het datumbereik Voorbeeld: "UTC"


Response (200 application/json)

Export succesvol.

Responsvelden:

  • success (boolean, vereist) — Geeft aan of de export succesvol was. Voorbeeld: true

  • data (object, vereist) — Informatie over exportgegevens:

    • data.filePath (string, vereist) — Pad naar het gegenereerde exportbestand Voorbeeld: "assistants-usage/workspace-id/assistants-usage-2024-01-01-2024-01-31-abc12345.csv"

    • data.downloadUrl (string, vereist) — Ondertekende URL om het exportbestand te downloaden Voorbeeld: "https://storage.example.com/signed-url"

    • data.dataType (enum, vereist) — Type gegevens dat geëxporteerd is. Beschikbare opties: assistants, users, workflows, projects, models Voorbeeld: "assistants"

    • data.recordCount (integer, vereist) — Aantal records in de export. Voorbeeld: 1250

    • data.dateRange (object, vereist) — Werkelijk datumbereik van de geëxporteerde gegevens