> ## Documentation Index
> Fetch the complete documentation index at: https://phaseo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取工作区分析

> 获取经过筛选的工作区费用、请求和 token 汇总数据。

<Note>此端点需要具有 `analytics:read` 权限的管理 API 密钥。</Note>

可按日期、请求标签、API 密钥、最终用户、模型、供应商、端点、凭据来源或结果筛选。结果按日期、模型、供应商和端点分组，并使用稳定分页。

时间范围最多为最近 30 个已结束的 UTC 日，源请求数最多为 10,000 个。


## OpenAPI

````yaml zh-Hans/openapi/v1/openapi.localized.yaml GET /analytics
openapi: 3.0.3
info:
  title: Phaseo Gateway API
  description: 通过兼容 OpenAI 的端点访问各种 AI 模型的网关 API。
  version: 1.0.0
  contact:
    name: Phaseo
    url: https://phaseo.app
    email: danielbutler500@gmail.com
servers:
  - url: https://api.phaseo.app/v1
    description: 全球路由
security:
  - BearerAuth: []
tags:
  - name: Gateway
    description: Core Phaseo Gateway operations.
paths:
  /analytics:
    get:
      tags:
        - Gateway
      summary: 获取工作区分析
      description: 返回最近30个完整UTC日按日期、模型、提供商和端点分组的成本、请求和令牌汇总。
      operationId: getActivityAlias
      parameters:
        - name: date
          in: query
          description: 按最近30个完整日中的单个UTC日期筛选（YYYY-MM-DD）。
          schema:
            type: string
            format: date
        - name: label_key
          in: query
          description: 支出切片中包含的请求标签键。必须与label_value一起提供。
          schema:
            type: string
            maxLength: 64
            pattern: ^[A-Za-z0-9_.:-]{1,64}$
        - name: label_value
          in: query
          description: 支出切片中包含的请求标签值。必须与label_key一起提供。
          schema:
            type: string
            maxLength: 256
        - name: key_id
          in: query
          description: 按API密钥标识符筛选。
          schema:
            type: string
        - name: end_user_id
          in: query
          description: 按应用定义的最终用户标识符筛选。
          schema:
            type: string
            maxLength: 256
        - name: model
          in: query
          description: 按请求或路由的规范模型标识筛选。
          schema:
            $ref: '#/components/schemas/ModelId'
        - name: provider
          in: query
          description: 按提供商标识筛选。
          schema:
            type: string
            maxLength: 128
        - name: endpoint
          in: query
          description: 按网关端点标识符筛选。
          schema:
            type: string
            maxLength: 128
        - name: byok
          in: query
          description: 筛选托管或BYOK流量。
          schema:
            type: boolean
        - name: success
          in: query
          description: 筛选成功或失败的请求。
          schema:
            type: boolean
        - $ref: '#/components/parameters/Offset'
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 1000
      responses:
        '200':
          description: 已获取
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsResponse'
        '400':
          description: 错误请求
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 未授权
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 禁止访问错误
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 内部服务器错误
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ModelId:
      type: string
      description: 模型标识符。这是运行时字符串，因此无需等待 SDK 更新即可使用新发布的模型。
      example: ai21/jamba-1.5-large
    AnalyticsResponse:
      type: object
      required:
        - data
        - total_count
        - offset
        - limit
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ActivityEntry'
        total_count:
          type: integer
          minimum: 0
        offset:
          type: integer
          minimum: 0
        limit:
          type: integer
          minimum: 1
          maximum: 1000
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        ok:
          type: boolean
          example: false
        error:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          example: error_type
        message:
          type: string
          example: Human-readable error message
        description:
          type: string
          example: Additional error details.
        generation_id:
          type: string
          example: G-abc123
        status_code:
          type: integer
          example: 502
        error_type:
          type: string
          enum:
            - user
            - system
          example: system
        error_origin:
          type: string
          enum:
            - user
            - gateway
            - upstream
          example: upstream
        reason:
          type: string
          example: all_candidates_failed
        attempt_count:
          type: integer
          example: 2
        failed_providers:
          type: array
          items:
            type: string
          example:
            - google-ai-studio
            - openai
        failed_statuses:
          type: array
          items:
            type: integer
          example:
            - 403
            - 429
        upstream_error:
          $ref: '#/components/schemas/ErrorUpstreamError'
        failure_sample:
          type: array
          items:
            $ref: '#/components/schemas/ErrorFailureSampleItem'
        provider_failure_diagnostics:
          $ref: '#/components/schemas/ErrorProviderFailureDiagnostics'
        routing_diagnostics:
          $ref: '#/components/schemas/ErrorRoutingDiagnostics'
        provider_candidate_diagnostics:
          $ref: '#/components/schemas/ErrorProviderCandidateDiagnostics'
        provider_enablement:
          $ref: '#/components/schemas/ErrorProviderEnablementDiagnostics'
        missing_pricing_providers:
          type: array
          items:
            type: string
        provider_payment_required_provider:
          type: string
          example: openai
        provider_payment_required_support_notice:
          type: string
          example: >-
            Our upstream provider billing appears to be unavailable. If this
            persists, contact support.
        details:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    ActivityEntry:
      type: object
      required:
        - date
        - model
        - model_permaslug
        - endpoint_id
        - provider_name
        - usage
        - byok_usage_inference
        - requests
        - prompt_tokens
        - completion_tokens
        - reasoning_tokens
      properties:
        date:
          type: string
          format: date
          example: '2025-08-24T00:00:00.000Z'
        model:
          type: string
          example: openai/gpt-4.1
        model_permaslug:
          type: string
          example: openai/gpt-4.1-2025-04-14
        endpoint_id:
          type: string
          example: chat.completions
        provider_name:
          type: string
          example: OpenAI
        usage:
          type: number
          example: 0.015
        byok_usage_inference:
          type: number
          example: 0.012
        requests:
          type: integer
          example: 5
        prompt_tokens:
          type: integer
          example: 50
        completion_tokens:
          type: integer
          example: 125
        reasoning_tokens:
          type: integer
          example: 25
      additionalProperties: false
    ErrorUpstreamError:
      type: object
      properties:
        code:
          type: string
          nullable: true
          example: PERMISSION_DENIED
        message:
          type: string
          nullable: true
          example: The caller does not have permission.
        description:
          type: string
          nullable: true
        param:
          type: string
          nullable: true
    ErrorFailureSampleItem:
      type: object
      properties:
        provider:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        status:
          type: integer
          nullable: true
        upstream_error_code:
          type: string
          nullable: true
        upstream_error_message:
          type: string
          nullable: true
        upstream_error_description:
          type: string
          nullable: true
        upstream_error_param:
          type: string
          nullable: true
        upstream_payload_preview:
          type: string
          nullable: true
        retryable:
          type: boolean
          nullable: true
      additionalProperties: true
    ErrorProviderFailureDiagnostics:
      type: object
      properties:
        category:
          type: string
          enum:
            - credentials_not_configured
            - credentials_invalid_or_forbidden
            - provider_access_missing
            - region_or_project_restriction
            - model_unavailable_for_endpoint
            - rate_limited
            - server_error
        hint:
          type: string
        provider:
          type: string
          nullable: true
    ErrorRoutingDiagnostics:
      type: object
      properties:
        filterStages:
          type: array
          items:
            type: object
            properties:
              stage:
                type: string
              beforeCount:
                type: integer
              afterCount:
                type: integer
              droppedProviders:
                type: array
                items:
                  type: object
                  properties:
                    providerId:
                      type: string
                      nullable: true
                    reason:
                      type: string
                      nullable: true
                  additionalProperties: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderCandidateDiagnostics:
      type: object
      properties:
        totalProviders:
          type: integer
        supportsEndpointCount:
          type: integer
        candidateCount:
          type: integer
        droppedUnsupportedEndpoint:
          type: array
          items:
            type: string
        droppedMissingAdapter:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              endpoint:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderEnablementDiagnostics:
      type: object
      properties:
        capability:
          type: string
        providersBefore:
          type: array
          items:
            type: string
        providersAfter:
          type: array
          items:
            type: string
        dropped:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              reason:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
  parameters:
    Offset:
      name: offset
      in: query
      required: false
      description: 要跳过的记录数。
      schema:
        type: integer
        minimum: 0
        default: 0
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer 令牌身份验证

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.