Exporteer workflowgebruik

Dit eindpunt exporteert workflowgebruikgegevens, waaronder uitvoeringsaantallen, succespercentages en prestatiestatistieken. Het is alleen beschikbaar als workflows zijn ingeschakeld in uw werkruimte.

Opmerking: Dit eindpunt retourneert geen gegevens als workflows niet zijn ingeschakeld in uw werkruimte. Neem contact op met uw werkruimtebeheerder om workflows in te schakelen indien nodig.

Eindpunt

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

Voorbeeldverzoek (cURL)

curl --request POST \
  --url https://api.langdock.com/export/workflows \
  --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"
    }
  }
}

Beschrijving

De export bevat workflowgebruikdetails zoals:

Workflowuitvoeringen
Succespercentages
Prestatiestatistieken
Foutenpercentages en -typen
Statistieken over uitvoeringstijd
Hulpbronnenverbruik

Aanvullende vereisten, snelheidslimieten en exportgroottebeperkingen: https://docs.langdock.com/api-endpoints/usage-export/intro-to-usage-export-api

Headers

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

Request body (application/json)

Request body voor usage-exporteindpunten

from (object, vereist) — Startdatum en tijdzone voor de export
- from.date (string, vereist) — Startdatum 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)

Succesvol antwoord van usage-exporteindpunten:

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
  - from (string) — Export startdatum
  - to (string) — Export einddatum

Opgenomen gegevens

De workflow-export bevat:

Workflowuitvoeringen
Succespercentages
Prestatiestatistieken
Foutenpercentages en -typen
Statistieken over uitvoeringstijd
Hulpbronnenverbruik

Voor meer details, zie: https://docs.langdock.com/api-endpoints/usage-export/intro-to-usage-export-api

Gerelateerd

Export Assistant Usage: https://docs.langdock.com/api-endpoints/usage-export/export-assistants
Export Project Usage: https://docs.langdock.com/api-endpoints/usage-export/export-projects

VorigeExporteer assistentgebruik VolgendeExporteer projectgebruik