İçeriğe geç
ajan.io

Belgeler menüsü

Bu sayfada

Kullanıcı kullanımını dışa aktar

Mesaj sayıları ve kullanım kalıpları dahil kullanıcı etkinlik verilerini dışa aktaran API endpoint'i (gizlilik ayarlarına bağlı)

Bu endpoint; mesaj sayıları, kullanım kalıpları ve özellik kullanımını içeren kullanıcı etkinlik verilerini dışa aktarır. Kullanılabilir veri, workspace gizlilik ayarlarınıza bağlıdı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.

Base URL

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

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

Gizlilik dikkate alınacaklar

User-level data ayarı, kullanıcı ayrıntı sütunlarının dahil edilip edilmeyeceğini kontrol eder. Kapalıyken aşağıdaki işaretli sütunlar — name ve email dahil — atlanır.

Dahil edilen veriler

Varsayılan olarak kullanıcı dışa aktarımı, seçilen dönem için kullanıcı başına bir satır döndürür.

ColumnDescription
period_startRaporun başlangıç tarihi
period_endRaporun bitiş tarihi
org_idWorkspace kimliği
user_idKullanıcı kimliği; yalnızca User-level data açıksa dahil edilir
nameKullanıcı adı; yalnızca User-level data açıksa dahil edilir
emailKullanıcı e-postası; yalnızca User-level data açıksa dahil edilir
roleKullanıcı rolü; yalnızca User-level data açıksa dahil edilir
joined_atKullanıcının workspace'e katıldığı tarih; yalnızca User-level data açıksa dahil edilir
departmentKullanıcı departmanı; yalnızca User-level data açıksa dahil edilir
company_nameKullanıcı şirket adı; yalnızca User-level data açıksa dahil edilir
license_typeGüncel lisans kademesi; yalnızca User-level data açıksa dahil edilir
payg_limit_currentGüncel ekstra kullanım limiti; yalnızca User-level data açıksa dahil edilir
payg_consumption_in_periodSeçilen dönemdeki ekstra kullanım tüketimi; yalnızca User-level data açıksa dahil edilir
payg_utilization_pct_currentpayg_consumption_in_period / payg_limit_current; yalnızca User-level data açıksa dahil edilir
messages_totalKullanıcının gönderdiği toplam mesaj
messages_total_rankToplam mesaja göre sıra
messages_chatAgent olmadan sohbetteki mesajlar
messages_chat_rankSohbet mesajlarına göre sıra
messages_assistantsAgent'lara gönderilen mesajlar
messages_assistants_rankAgent mesajlarına göre sıra
assistants_messagedMesaj gönderilen benzersiz agent sayısı
assistants_to_messagesAgent ID'sinden mesaj sayısına JSON eşlemesi
messages_projectsProjelere gönderilen mesajlar
messages_projects_rankProje mesajlarına göre sıra
projects_messagedMesaj gönderilen benzersiz proje sayısı
projects_to_messagesProje ID'sinden mesaj sayısına JSON eşlemesi
model_to_messages_totalModel adından mesaj sayısına JSON eşlemesi
action_messagesAction'lar tarafından üretilen mesajlar
action_messagedTetiklenen benzersiz action sayısı
action_to_messagesAction adından mesaj sayısına JSON eşlemesi

BYOK workspace'leri için ek sütunlar

ColumnDescription
total_input_tokensKullanıcının tükettiği toplam girdi token'ı
total_output_tokensKullanıcı için üretilen toplam çıktı token'ı
cached_prompt_tokensÖnbellekten okunan girdi token'ları
cache_creation_tokensÖnbelleğe yazılan girdi token'ları
no_cache_tokensÖnbellekten sunulmayan girdi token'ları
total_cost_usdUSD cinsinden tahmini sağlayıcı maliyeti

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

Gruplanmış dışa aktarım

Kullanıcı ve model başına bir satır için group_by=model kullanın.

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/users:
    post:
      tags:
        - Usage Export
      summary: Export user usage data
      description: >-
        Export detailed usage data for all users in the workspace (subject to
        privacy settings)
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsageExportModelGroupByRequest'
      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:
    UsageExportModelGroupByRequest:
      allOf:
        - $ref: '#/components/schemas/UsageExportRequest'
        - type: object
          properties:
            group_by:
              type: string
              description: Optional aggregation dimension.
              enum:
                - model
    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
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key as Bearer token. Format "Bearer YOUR_API_KEY"