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/usersDedicated deployments Tüm isteklerde
api.ajan.com'u/api/publicile 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.
| Column | Description |
|---|---|
period_start | Raporun başlangıç tarihi |
period_end | Raporun bitiş tarihi |
org_id | Workspace kimliği |
user_id | Kullanıcı kimliği; yalnızca User-level data açıksa dahil edilir |
name | Kullanıcı adı; yalnızca User-level data açıksa dahil edilir |
email | Kullanıcı e-postası; yalnızca User-level data açıksa dahil edilir |
role | Kullanıcı rolü; yalnızca User-level data açıksa dahil edilir |
joined_at | Kullanıcının workspace'e katıldığı tarih; yalnızca User-level data açıksa dahil edilir |
department | Kullanıcı departmanı; yalnızca User-level data açıksa dahil edilir |
company_name | Kullanıcı şirket adı; yalnızca User-level data açıksa dahil edilir |
license_type | Güncel lisans kademesi; yalnızca User-level data açıksa dahil edilir |
payg_limit_current | Güncel ekstra kullanım limiti; yalnızca User-level data açıksa dahil edilir |
payg_consumption_in_period | Seçilen dönemdeki ekstra kullanım tüketimi; yalnızca User-level data açıksa dahil edilir |
payg_utilization_pct_current | payg_consumption_in_period / payg_limit_current; yalnızca User-level data açıksa dahil edilir |
messages_total | Kullanıcının gönderdiği toplam mesaj |
messages_total_rank | Toplam mesaja göre sıra |
messages_chat | Agent olmadan sohbetteki mesajlar |
messages_chat_rank | Sohbet mesajlarına göre sıra |
messages_assistants | Agent'lara gönderilen mesajlar |
messages_assistants_rank | Agent mesajlarına göre sıra |
assistants_messaged | Mesaj gönderilen benzersiz agent sayısı |
assistants_to_messages | Agent ID'sinden mesaj sayısına JSON eşlemesi |
messages_projects | Projelere gönderilen mesajlar |
messages_projects_rank | Proje mesajlarına göre sıra |
projects_messaged | Mesaj gönderilen benzersiz proje sayısı |
projects_to_messages | Proje ID'sinden mesaj sayısına JSON eşlemesi |
model_to_messages_total | Model adından mesaj sayısına JSON eşlemesi |
action_messages | Action'lar tarafından üretilen mesajlar |
action_messaged | Tetiklenen benzersiz action sayısı |
action_to_messages | Action adından mesaj sayısına JSON eşlemesi |
BYOK workspace'leri için ek sütunlar
| Column | Description |
|---|---|
total_input_tokens | Kullanıcının tükettiği toplam girdi token'ı |
total_output_tokens | Kullanı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_usd | USD 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"