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

# 查询指标

> 查询特定收件箱的使用量或送达指标。



## OpenAPI

````yaml openapi/zh/agentmail.json GET /agentmail/inboxes/{inbox_id}/metrics
openapi: 3.1.0
info:
  title: AgentMail API
  version: 1.0.0
  description: 通过 AIsa 统一网关公开的 AgentMail 电子邮件 API 端点。改编自上游 docs.agentmail.to OpenAPI 规范。
servers:
  - url: https://api.aisa.one/apis/v1
security:
  - Bearer: []
paths:
  /agentmail/inboxes/{inbox_id}/metrics:
    get:
      tags:
        - subpackage_inboxes.subpackage_inboxes/metrics
      summary: 查询指标
      description: |-
        **CLI：**
        ```bash
        agentmail inboxes:metrics query --inbox-id <inbox_id>
        ```
      operationId: get_agentmail_inboxes_inbox_id_metrics
      parameters:
        - name: inbox_id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/type_inboxes_InboxId'
        - name: event_types
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/type_metrics_MetricEventTypes'
        - name: start
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/type_metrics_Start'
        - name: end
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/type_metrics_End'
        - name: period
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/type_metrics_Period'
        - name: limit
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/type_metrics_MetricLimit'
        - name: descending
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/type_metrics_Descending'
        - name: Authorization
          in: header
          description: Bearer 身份验证
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 状态码为 200 的响应
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_metrics_QueryMetricsResponse'
        '400':
          description: 状态码为 400 的错误响应
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__ValidationErrorResponse'
components:
  schemas:
    type_inboxes_InboxId:
      type: string
      description: 收件箱的 ID。
      title: InboxId
    type_metrics_MetricEventTypes:
      type: array
      items:
        $ref: '#/components/schemas/type_metrics_MetricEventType'
      description: 要查询的指标事件类型列表。
      title: MetricEventTypes
    type_metrics_Start:
      type: string
      format: date-time
      description: 查询的开始时间戳。
      title: Start
    type_metrics_End:
      type: string
      format: date-time
      description: 查询的结束时间戳。
      title: End
    type_metrics_Period:
      type: string
      description: 查询周期，以秒为单位。
      title: Period
    type_metrics_MetricLimit:
      type: integer
      description: 返回的桶数量上限。
      title: MetricLimit
    type_metrics_Descending:
      type: boolean
      description: 按降序排序。
      title: Descending
    type_metrics_QueryMetricsResponse:
      type: object
      additionalProperties:
        type: array
        items:
          $ref: '#/components/schemas/type_metrics_MetricBucket'
      description: 按事件类型分组的指标。
      title: QueryMetricsResponse
    type__ValidationErrorResponse:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/type__ErrorName'
        errors:
          description: 验证错误。
      required:
        - name
        - errors
      title: ValidationErrorResponse
    type_metrics_MetricEventType:
      type: string
      enum:
        - message.sent
        - message.delivered
        - message.bounced
        - message.delayed
        - message.rejected
        - message.complained
        - message.received
      description: 指标事件的类型。
      title: MetricEventType
    type_metrics_MetricBucket:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          description: 时间桶的时间戳。
        count:
          type: integer
          description: 存储桶中的事件数量。
      required:
        - timestamp
        - count
      title: MetricBucket
    type__ErrorName:
      type: string
      description: 错误名称。
      title: ErrorName
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````