İş akışı kullanımını dışa aktar

Maliyet, çalıştırma sayıları ve aylık limit kullanımı dahil iş akışı kullanım verilerini dışa aktaran API endpoint'i

Bu endpoint; iş akışı başına maliyet, çalıştırma sayıları ve aylık limit kullanımı dahil iş akışı kullanım verilerini dışa aktarır.

Başlamadan önce

Önkoşullar ve rate limit'ler: Usage Export API overview sayfasına bakın.
Tarayıcı istekleri: ajan, API anahtarınızı korumak için tarayıcı kaynaklı istekleri bilinçli olarak engeller. API anahtarlarını sunucu tarafında kullanın ve güvenli saklayın. Bkz. API Key Best Practices.
Gizlilik: Kullanıcı düzeyinde veri kapalıyken workflow_owner_id ve workflow_owner_email atlanır; yalnızca sahibe özel private iş akışları hariç tutulur.

Base URL

https://api.ajan.io/export/workflows

Dedicated deployments Tüm isteklerde api.ajan.com'u /api/public ile değiştirin.

Dahil edilen veriler

İş akışı dışa aktarımı, seçilen dönemde çalıştırma veya maliyeti olan şablon olmayan her iş akışı için bir satır döndürür.

Column	Description
`period_start`	Raporun başlangıç tarihi
`period_end`	Raporun bitiş tarihi
`org_id`	Workspace kimliği
`workflow_id`	İş akışı kimliği
`workflow_name`	İş akışı adı
`status`	`ACTIVE`, `INACTIVE` veya `NOT_DEPLOYED`
`runs`	Seçilen dönemdeki iş akışı çalıştırma sayısı
`total_cost_usd`	Seçilen dönem için USD cinsinden maliyet
`monthly_limit_usd`	İş akışının güncel aylık USD limiti; limit yoksa `null`
`current_month_cost_usd`	Güncel takvim ayı için USD cinsinden maliyet
`monthly_utilization_pct_current`	`current_month_cost_usd / monthly_limit_usd`; limit yoksa `null`
`workflow_owner_id`	İş akışı sahibi kimliği; kullanıcı düzeyinde veri kapalıysa hariç
`workflow_owner_email`	İş akışı sahibi e-postası; kullanıcı düzeyinde veri kapalıysa hariç

monthly_limit_usd, current_month_cost_usd ve monthly_utilization_pct_current, iş akışının aylık USD limiti ile güncel takvim ayı harcamasını kullanır. Kullanıcı dışa aktarımındaki ekstra kullanım alanları değildir.

BYOK workspace'leri için ek sütunlar

Column	Description
`sum_input_tokens`	Toplam girdi token'ı
`sum_cached_input_tokens`	Önbellekten okunan girdi token'ları
`sum_cache_creation_tokens`	Önbelleğe yazılan girdi token'ları
`sum_output_tokens`	Toplam çıktı token'ı

BYOK workspace'leri kendi model anahtarlarını sağladığı için ajan, token tüketim verilerini doğrudan sunabilir. Modellerinizi doğrudan ajan üzerinden aldığınızda bu mümkün değildir.

group_by, iş akışı dışa aktarımlarında desteklenmez.

OpenAPI

openapi: 3.0.0
info:
  title: ajan API
  version: 3.0.0
servers:
  - url: https://api.ajan.io
    description: Production
security:
  - bearerAuth: []
paths:
  /export/workflows:
    post:
      tags:
        - Usage Export
      summary: Export workflow usage data
      description: >-
        Export cost, run counts, and monthly cap utilization for workflows in
        the workspace
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsageExportRequest'
      responses:
        '200':
          description: Export successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageExportResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageExportError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageExportError'
        '404':
          description: No data found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageExportError'
components:
  schemas:
    UsageExportRequest:
      type: object
      description: Request body for usage export endpoints
      properties:
        from:
          type: object
          description: Start date and timezone for the export
          properties:
            date:
              type: string
              format: date-time
              description: Start date in ISO 8601 format
              example: '2024-01-01T00:00:00.000Z'
            timezone:
              type: string
              description: Timezone for the date range
              example: UTC
          required:
            - date
            - timezone
        to:
          type: object
          description: End date and timezone for the export
          properties:
            date:
              type: string
              format: date-time
              description: End date in ISO 8601 format
              example: '2024-01-31T23:59:59.999Z'
            timezone:
              type: string
              description: Timezone for the date range
              example: UTC
          required:
            - date
            - timezone
      required:
        - from
        - to
    UsageExportResponse:
      type: object
      description: Successful response from usage export endpoints
      properties:
        success:
          type: boolean
          description: Indicates if the export was successful
          example: true
        data:
          type: object
          description: Export data information
          properties:
            filePath:
              type: string
              description: Path to the generated export file
              example: >-
                agents-usage/workspace-id/agents-usage-2024-01-01-2024-01-31-abc12345.csv
            downloadUrl:
              type: string
              format: uri
              description: Signed URL to download the export file
              example: https://storage.example.com/signed-url
            dataType:
              type: string
              description: Type of data exported
              enum:
                - assistants
                - agents
                - api_keys
                - users
                - projects
                - models
                - workflows
              example: assistants
            recordCount:
              type: integer
              description: Number of records in the export
              example: 1250
            dateRange:
              type: object
              description: Actual date range of the exported data
              properties:
                from:
                  type: string
                  format: date-time
                  description: Start date of the export
                  example: '2024-01-01T00:00:00.000Z'
                to:
                  type: string
                  format: date-time
                  description: End date of the export
                  example: '2024-01-31T23:59:59.999Z'
              required:
                - from
                - to
          required:
            - filePath
            - downloadUrl
            - dataType
            - recordCount
            - dateRange
      required:
        - success
        - data
    UsageExportError:
      type: object
      description: Error response from usage export endpoints
      properties:
        message:
          type: string
          description: Detailed error message
          example: No usage data found for the selected period
        code:
          type: string
          description: Machine-readable error code
          example: NOT_FOUND
        details:
          type: object
          description: >-
            Additional error context. Oversized exports include the scanned row
            counts and the configured row limit.
      required:
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key as Bearer token. Format "Bearer YOUR_API_KEY"