> ## Documentation Index > Fetch the complete documentation index at: https://veniceai-mintlify-6ce01df5.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Analíticas de uso de facturación (Beta) > **Beta**: This endpoint is currently in beta and may be unstable. Request/response schemas and behavior may change without notice. Get aggregated usage analytics for the authenticated user with breakdowns by date, model, and API key. This endpoint provides summary views of your API usage, ideal for dashboards and usage monitoring. Data is cached for 10 minutes. Este es un endpoint en beta y puede ser inestable o cambiar sin previo aviso. Obtén analíticas de uso agregadas para el usuario autenticado, con desgloses por fecha, modelo y API key. Este endpoint proporciona vistas resumidas de los datos de uso de tu API para crear paneles y monitorizar el consumo. Los datos se almacenan en caché durante 10 minutos. ## Parámetros de consulta Puedes especificar el periodo de tiempo para las analíticas mediante: * **lookback**: un periodo relativo como "7d" (7 días), "30d" (30 días), hasta "90d" (90 días) * **startDate** y **endDate**: un rango de fechas personalizado en formato `YYYY-MM-DD`. Ambos son obligatorios si se proporciona alguno. Si no se especifica ningún parámetro, el periodo de lookback predeterminado es de 7 días. ## Campos de respuesta ### lookback El periodo de lookback utilizado para la consulta. Puede estar en formato "Nd" (p. ej., "7d") o "startDate:endDate". ### byDate Totales de uso diarios para el periodo solicitado. * **date**: la fecha en formato `YYYY-MM-DD` * **USD**: uso total en USD para ese día * **DIEM**: uso total en DIEM para ese día ### byModel Desglose de uso por modelo, ordenado por gasto total (mayor primero). * **modelName**: nombre del modelo para mostrar (p. ej., "GLM 5") * **unitType**: tipo de unidades consumidas (tokens, images, chars, minutes, seconds) * **modelType**: tipo de modelo (LLM, IMAGE, TTS, ASR, VIDEO), o null * **totalUsd**: total en USD gastado en este modelo * **totalDiem**: total en DIEM gastado en este modelo * **totalUnits**: total de unidades consumidas para este modelo * **breakdown**: array de desgloses de uso por tipo (solo presente si hay múltiples tipos). Cada entrada contiene: * **type**: tipo de token (p. ej., "Input", "Output", "Cache Read", "Cache Write") * **usd**: importe en USD para este desglose * **diem**: importe en DIEM para este desglose * **units**: número de unidades para este desglose ### byModelDaily Datos de gráfico diarios para los 8 modelos principales. Cada entrada contiene una "date" (timestamp) más los nombres de modelo como claves con valores de uso en DIEM. ### topModels Array de los 8 nombres de modelos principales por uso, para leyendas de gráficos. ### byKey Desglose de uso por API key, ordenado por gasto total (mayor primero). * **apiKeyId**: el ID de la API key, o null si el uso provino de la aplicación web * **description**: descripción de la API key o "Web App" * **totalUsd**: total en USD gastado mediante esta clave * **totalDiem**: total en DIEM gastado mediante esta clave * **totalUnits**: total de unidades consumidas mediante esta clave ### byKeyDaily Datos de gráfico diarios para las 8 API keys principales. Cada entrada contiene una "date" (timestamp) más las descripciones de las claves como claves con valores de uso en DIEM. ### topKeyNames Array de las 8 descripciones de API key principales por uso, para leyendas de gráficos. ## Ejemplo de uso ```bash theme={"system"} # Obtener analíticas de uso de los últimos 7 días (predeterminado) curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics" \ -H "Authorization: Bearer YOUR_API_KEY" # Obtener analíticas de uso de los últimos 30 días curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics?lookback=30d" \ -H "Authorization: Bearer YOUR_API_KEY" # Obtener analíticas de uso para un rango de fechas específico curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics?startDate=2024-01-01&endDate=2024-01-31" \ -H "Authorization: Bearer YOUR_API_KEY" ``` ## OpenAPI ````yaml GET /billing/usage-analytics openapi: 3.0.0 info: description: The Venice.ai API. termsOfService: https://venice.ai/legal/tos title: Venice.ai API version: '20260617.063120' x-guidance: >- Venice.ai is an OpenAI-compatible inference API supporting text, image, audio, and video generation. **Authentication options:** - API Key: Use Bearer token in Authorization header - x402 Wallet: Use USDC credits via EVM or Solana wallet (no account required) **For x402 wallet access:** 1. POST /x402/top-up without headers to get payment requirements 2. Choose one of the returned Base or Solana payment options and sign a USDC payment using the x402 SDK 3. POST /x402/top-up with PAYMENT-SIGNATURE header to add credits 4. Call any inference endpoint with SIGN-IN-WITH-X header **Pricing:** Prepaid credits consumed per request. Check /models for available models and their capabilities. servers: - url: https://api.venice.ai/api/v1 security: - BearerAuth: [] tags: - description: >- Generate speech/audio, transcribe audio, and manage asynchronous audio generation jobs. name: Audio - description: >- Given a list of messages comprising a conversation, the model will return a response. Supports multimodal inputs including text, images, audio (input_audio), and video (video_url) for compatible models. name: Chat - description: List and describe the various models available in the API. name: Models - description: Generate and manipulate images using AI models. name: Image - description: Generate videos using AI models. name: Video - description: List and retrieve character information for use in completions. name: Characters - description: >- Billing and usage analytics. **Beta**: This API is currently in beta and may be unstable. Endpoints, request/response schemas, and behavior may change without notice. name: Billing - description: Proxy JSON-RPC requests to blockchain nodes. Billed per credit. name: Crypto RPC - description: >- Wallet-based API access using the x402 protocol. No API key required — authenticate with an EVM or Solana wallet. **How it works:** 1. **Authenticate** — Send a `SIGN-IN-WITH-X` header (base64-encoded signed SIWX payload) with any request. EVM wallets sign an EIP-4361 SIWE message; Solana wallets sign the Solana SIWX message with Ed25519. See the `siwx` security scheme for the exact format. 2. **Top up** — `POST /x402/top-up` without a payment header returns an `accepts` array with Base and Solana USDC payment options. Choose one entry, sign it using the x402 SDK (`npm install x402`), and re-submit with the `PAYMENT-SIGNATURE` header (the legacy `X-402-Payment` and `X-PAYMENT` names are also accepted). 3. **Use any endpoint** — All inference endpoints (chat, image, audio, video, embeddings) accept `siwx` as an alternative to `BearerAuth`. Charges are deducted from your USDC credit balance. 4. **Monitor balance** — `GET /x402/balance/{walletAddress}` returns your current balance. The `X-Balance-Remaining` response header on inference calls also reports it. **Quick start (5 lines):** ``` import { VeniceClient } from '@venice-ai/x402-client' const venice = new VeniceClient(process.env.WALLET_KEY) await venice.topUp(10) // $10 USDC on a supported x402 rail const res = await venice.chat({ model: 'zai-org-glm-5-1', messages: [{ role: 'user', content: 'Hello!' }] }) ``` **Payment:** USDC on Base (chain ID 8453) or Solana mainnet. Minimum top-up: $5. Alternatively, stake DIEM tokens for daily credits (1 DIEM = $1/day). name: x402 externalDocs: description: Venice.ai API documentation url: https://docs.venice.ai paths: /billing/usage-analytics: get: tags: - Billing summary: /api/v1/billing/usage-analytics description: >- **Beta**: This endpoint is currently in beta and may be unstable. Request/response schemas and behavior may change without notice. Get aggregated usage analytics for the authenticated user with breakdowns by date, model, and API key. This endpoint provides summary views of your API usage, ideal for dashboards and usage monitoring. Data is cached for 10 minutes. operationId: getBillingUsageAnalytics parameters: - schema: type: string pattern: ^[1-9]\d*d$ default: 7d description: >- Lookback period for usage data. Format: number followed by "d" (e.g., "7d", "30d"). Maximum: 90d example: 7d required: false name: lookback in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Start date for filtering records (YYYY-MM-DD). If provided, endDate is also required. example: '2024-01-01T00:00:00.000Z' required: false name: startDate in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- End date for filtering records (YYYY-MM-DD). If provided, startDate is also required. example: '2024-01-31T00:00:00.000Z' required: false name: endDate in: query responses: '200': description: Successful response with aggregated usage analytics content: application/json: schema: type: object properties: lookback: type: string description: >- The lookback period used for the query. Either "Nd" format or "startDate:endDate" format. example: 7d byDate: type: array items: type: object properties: date: type: string description: Date in YYYY-MM-DD format example: '2024-01-15T00:00:00.000Z' USD: type: number description: Total USD usage for this date DIEM: type: number description: Total DIEM usage for this date required: - date - USD - DIEM description: Daily usage totals for the requested period byModel: type: array items: type: object properties: modelName: type: string description: Display name of the model example: GLM 5.1 unitType: type: string description: >- Type of units (tokens, images, chars, minutes, seconds) example: tokens modelType: type: string nullable: true description: Type of model (LLM, IMAGE, TTS, ASR, VIDEO) example: LLM totalUsd: type: number description: Total USD usage for this model totalDiem: type: number description: Total DIEM usage for this model totalUnits: type: number description: Total units consumed for this model breakdown: type: array items: type: object properties: type: type: string description: >- Token type (e.g., "Input", "Output", "Cache Read", "Cache Write") usd: type: number description: USD amount for this breakdown diem: type: number description: DIEM amount for this breakdown units: type: number description: Number of units for this breakdown required: - type - usd - diem - units description: >- Breakdown by token type (only present if multiple types) required: - modelName - unitType - modelType - totalUsd - totalDiem - totalUnits description: >- Usage breakdown by model, sorted by total spend (highest first) byModelDaily: type: array items: type: object additionalProperties: type: number description: >- Daily chart data for top 8 models. Each entry has "date" (timestamp) plus model names as keys. topModels: type: array items: type: string description: Names of the top 8 models by usage (for chart legends) byKey: type: array items: type: object properties: apiKeyId: type: string nullable: true description: API key ID, or null if usage was from web app description: type: string description: API key description or "Web App" example: My Production Key totalUsd: type: number description: Total USD usage for this key totalDiem: type: number description: Total DIEM usage for this key totalUnits: type: number description: Total units consumed for this key required: - apiKeyId - description - totalUsd - totalDiem - totalUnits description: >- Usage breakdown by API key, sorted by total spend (highest first) byKeyDaily: type: array items: type: object additionalProperties: type: number description: >- Daily chart data for top 8 API keys. Each entry has "date" (timestamp) plus key descriptions as keys. topKeyNames: type: array items: type: string description: >- Descriptions of the top 8 API keys by usage (for chart legends) required: - lookback - byDate - byModel - byModelDaily - topModels - byKey - byKeyDaily - topKeyNames additionalProperties: false description: >- Aggregated usage analytics response with breakdowns by date, model, and API key example: lookback: 7d byDate: - date: '2024-01-15T00:00:00.000Z' USD: 0.5 DIEM: 10.25 - date: '2024-01-14T00:00:00.000Z' USD: 0.3 DIEM: 8.75 byModel: - modelName: GLM 5.1 unitType: tokens modelType: LLM totalUsd: 0.4 totalDiem: 12.5 totalUnits: 50000 breakdown: - type: Output usd: 0.3 diem: 10 units: 35000 - type: Input usd: 0.1 diem: 2.5 units: 15000 byModelDaily: - date: 1705276800000 GLM 5.1: 5.5 Kimi K2.6: 3.2 topModels: - GLM 5.1 - Kimi K2.6 byKey: - apiKeyId: key_abc123 description: Production Key totalUsd: 0.8 totalDiem: 15 totalUnits: 75000 - apiKeyId: null description: Web App totalUsd: 0 totalDiem: 4 totalUnits: 25000 byKeyDaily: - date: 1705276800000 Production Key: 8.5 Web App: 2 topKeyNames: - Production Key - Web App '400': description: Invalid request parameters content: application/json: schema: $ref: '#/components/schemas/DetailedError' '401': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/StandardError' '500': description: Inference processing failed content: application/json: schema: $ref: '#/components/schemas/StandardError' '504': description: Query timed out - try reducing the lookback period content: application/json: schema: properties: error: description: Error message indicating query timeout type: string type: object components: schemas: DetailedError: type: object properties: details: type: object properties: {} description: Details about the incorrect input example: _errors: [] field: _errors: - Field is required error: type: string description: A description of the error required: - error StandardError: type: object properties: error: type: string description: A description of the error required: - error securitySchemes: BearerAuth: bearerFormat: JWT scheme: bearer type: http ````