Exporteer assistentgebruik

Deze endpoint exporteert gebruiksgegevens van assistenten, inclusief berichtenaantallen per assistent, aantallen actieve gebruikers en gebruikstrends in de tijd.

cURL
curl --request POST \
  --url https://api.langdock.com/export/assistants \
  --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"
  }
}
'
Voorbeeld van een succesvolle respons (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"
    }
  }
}

Opgenomen gegevens

De assistentexport bevat:

  • Aantal berichten per assistent

  • Actieve gebruikers per assistent

  • Gebruikstrends in de tijd

  • Details van assistentconfiguratie

  • Prestatiestatistieken

Aanvullende informatie

Voor details over vereisten, snelheidslimieten en limieten voor exportgrootte, raadpleeg alstublieft de hoofddocumentatie van de Usage Export API.

Eindpunt

POST /export/assistants

Headers

  • Autorisatie (string, vereist)

    • API-sleutel als Bearer-token met de USAGE_EXPORT_API-scope. Formaat: "Bearer YOUR_API_KEY"

  • Content-Type: application/json

Voeg de Authorization-header toe met een Bearer-token dat de USAGE_EXPORT_API-scope heeft.

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"

Responses

  • 200 application/json — Export geslaagd

Responsschema (succesvolle respons):

  • 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) — Gesigneerde 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

      • data.dateRange.from (string, vereist) — Begindatum van de export. Voorbeeld: "2024-01-01T00:00:00.000Z"

      • data.dateRange.to (string, vereist) — Einddatum van de export. Voorbeeld: "2024-01-31T23:59:59.999Z"

Gerelateerd

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

  • Export Workflow Usage: https://docs.langdock.com/api-endpoints/usage-export/export-workflows

VorigeExporteer gebruikersgebruikVolgendeExporteer workflowgebruik