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

# 获取间隔指标

> Retrieves a list of metrics, aggregated for a given interval.



## OpenAPI

````yaml GET /metrics
openapi: 3.0.2
info:
  title: ORION Platform REST API
  description: OpenApi Spec for ORION Camunda Platform REST API.
  version: 7.22.6-ee
  license:
    name: Apache License 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://{host}:{port}/{contextPath}
    description: The API server for the default process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
  - url: http://{host}:{port}/{contextPath}/engine/{engineName}
    description: The API server for a named process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
      engineName:
        default: default
  - url: '{url}'
    description: The API server with a custom url
    variables:
      url:
        default: ''
security:
  - basicAuth: []
tags:
  - name: Authorization
  - name: Batch
  - name: Condition
  - name: Decision Definition
  - name: Decision Requirements Definition
  - name: Deployment
  - name: Engine
  - name: Event Subscription
  - name: Execution
  - name: External Task
  - name: Filter
  - name: Group
  - name: Historic Activity Instance
  - name: Historic Batch
  - name: Historic Decision Definition
  - name: Historic Decision Instance
  - name: Historic Decision Requirements Definition
  - name: Historic Detail
  - name: Historic External Task Log
  - name: Historic Identity Link Log
  - name: Historic Incident
  - name: Historic Job Log
  - name: Historic Process Definition
  - name: Historic Process Instance
  - name: Historic Task Instance
  - name: Historic User Operation Log
  - name: Historic Variable Instance
  - name: History Cleanup
  - name: Identity
  - name: Incident
  - name: Job
  - name: Job Definition
  - name: Message
  - name: Metrics
  - name: Migration
  - name: Modification
  - name: Process Definition
  - name: Process Instance
  - name: Signal
  - name: Schema Log
  - name: Task
  - name: Task Attachment
  - name: Task Comment
  - name: Task Identity Link
  - name: Task Local Variable
  - name: Task Variable
  - name: Telemetry
  - name: Tenant
  - name: User
  - name: Variable Instance
  - name: Version
externalDocs:
  description: Find out more about ORION Rest API
  url: https://docs.eorion.com
paths:
  /metrics:
    get:
      tags:
        - Metrics
      summary: Get Metrics in Interval
      description: Retrieves a list of metrics, aggregated for a given interval.
      operationId: interval
      parameters:
        - name: name
          in: query
          schema:
            enum:
              - activity-instance-start
              - activity-instance-end
              - decision-instances
              - flow-node-instances
              - job-acquisition-attempt
              - job-acquired-success
              - job-acquired-failure
              - job-execution-rejected
              - job-successful
              - job-failed
              - job-locked-exclusive
              - executed-decision-elements
              - history-cleanup-removed-process-instances
              - history-cleanup-removed-case-instances
              - history-cleanup-removed-decision-instances
              - history-cleanup-removed-batch-operations
              - history-cleanup-removed-task-metrics
              - process-instances
            type: string
          description: The name of the metric.
        - name: reporter
          in: query
          schema:
            type: string
          description: >-
            The name of the reporter (host), on which the metrics was logged.
            This will have

            value provided by the [hostname configuration
            property](https://docs.camunda.org/manual/7.22/reference/deployment-descriptors/tags/process-engine/#hostname).
        - name: startDate
          in: query
          schema:
            type: string
            format: date-time
          description: The start date (inclusive).
        - name: endDate
          in: query
          schema:
            type: string
            format: date-time
          description: The end date (exclusive).
        - name: firstResult
          in: query
          schema:
            type: integer
          description: >-
            Pagination of results. Specifies the index of the first result to
            return.
        - name: maxResults
          in: query
          schema:
            type: integer
          description: >-
            Pagination of results. Specifies the maximum number of results to
            return.

            Will return less results if there are no more results left.
        - name: interval
          in: query
          schema:
            default: 900
            type: string
          description: >-
            The interval for which the metrics should be aggregated. Time unit
            is seconds.

            Default: The interval is set to 15 minutes (900 seconds).
        - name: aggregateByReporter
          in: query
          schema:
            type: string
          description: Aggregate metrics by reporter.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetricsIntervalResultDto'
              examples:
                example-1:
                  summary: >-
                    GET
                    /metrics?name=flow-node-instances&startDate=1970-01-01T01:45:00.000%2b0200&endDate=1970-01-01T02:00:00.000%2b0200
                  value:
                    - timestamp: 1970-01-01T01:45:00.000+0200
                      name: flow-node-instances
                      reporter: REPORTER
                      value: 23
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: Returned if some of the query parameters are invalid.
components:
  schemas:
    MetricsIntervalResultDto:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          nullable: true
          description: The interval timestamp.
        name:
          type: string
          nullable: true
          description: The name of the metric.
        reporter:
          type: string
          nullable: true
          description: >-
            The reporter of the metric. `null` if the metrics are aggregated by
            reporter.
        value:
          type: integer
          format: int64
          nullable: true
          description: The value of the metric aggregated by the interval.
    ExceptionDto:
      title: ExceptionDto
      type: object
      properties:
        type:
          type: string
          nullable: true
          description: An exception class indicating the occurred error.
        message:
          type: string
          nullable: true
          description: A detailed message of the error.
        code:
          type: number
          description: >-
            The code allows your client application to identify the error in an
            automated fashion.

            You can look up the meaning of all built-in codes and learn how to
            add custom codes

            in the [User
            Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/error-handling/#exception-codes).
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````