> ## 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 report about the duration of completed process instances, grouped by a period.
These reports include the maximum, minimum and average duration of all completed process instances which were started in a given period.

**Note:** This only includes historic data.



## OpenAPI

````yaml GET /history/process-instance/report
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:
  /history/process-instance/report:
    get:
      tags:
        - Historic Process Instance
      summary: Get Duration Report
      description: >-
        Retrieves a report about the duration of completed process instances,
        grouped by a period.

        These reports include the maximum, minimum and average duration of all
        completed process instances which were started in a given period.


        **Note:** This only includes historic data.
      operationId: getHistoricProcessInstanceDurationReport
      parameters:
        - name: reportType
          in: query
          schema:
            type: string
          required: true
          description: >-
            **Mandatory.** Specifies the type of the report to retrieve.

            To retrieve a report about the duration of process instances, the
            value must be set to `duration`.
        - name: periodUnit
          in: query
          schema:
            enum:
              - month
              - quarter
            type: string
          required: true
          description: >-
            **Mandatory.** Specifies the granularity of the report. Valid values
            are `month` and `quarter`.
        - name: processDefinitionIdIn
          in: query
          schema:
            type: string
          description: >-
            Filter by process definition ids. Must be a comma-separated list of
            process definition ids.
        - name: processDefinitionKeyIn
          in: query
          schema:
            type: string
          description: >-
            Filter by process definition keys. Must be a comma-separated list of
            process definition keys.
        - name: startedBefore
          in: query
          schema:
            type: string
            format: date-time
          description: >-
            Restrict to instances that were started before the given date.

            By [default](), the date must have the format
            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`.
        - name: startedAfter
          in: query
          schema:
            type: string
            format: date-time
          description: >-
            Restrict to instances that were started after the given date.

            By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),
            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
            `2016-01-23T14:42:45.000+0200`.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DurationReportResultDto'
              examples:
                example-1:
                  summary: >-
                    GET
                    `/history/process-instance/report?reportType=duration&periodUnit=quarter&processDefinitionKeyIn=invoice`
                  value:
                    - period: 1
                      periodUnit: QUARTER
                      maximum: 500000
                      minimum: 250000
                      average: 375000
                    - period: 2
                      periodUnit: QUARTER
                      maximum: 600000
                      minimum: 300000
                      average: 450000
                    - period: 3
                      periodUnit: QUARTER
                      maximum: 1000000
                      minimum: 500000
                      average: 750000
                    - period: 4
                      periodUnit: QUARTER
                      maximum: 200000
                      minimum: 100000
                      average: 150000
            application/csv:
              schema: {}
            text/csv:
              schema: {}
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Returned if some of the query parameters are invalid or mandatory
            parameters are not supplied.

            See the
            [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling)
            for the error response format.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            If the authenticated user is unauthorized to read the history.

            See the
            [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling)
            for the error response format.
components:
  schemas:
    DurationReportResultDto:
      type: object
      properties:
        period:
          type: integer
          format: int32
          nullable: true
          description: >-
            Specifies a timespan within a year.

            **Note:** The period must be interpreted in conjunction with the
            returned `periodUnit`.
        periodUnit:
          type: string
          nullable: true
          enum:
            - MONTH
            - QUARTER
          description: >-
            The unit of the given period. Possible values are `MONTH` and
            `QUARTER`.
        minimum:
          type: integer
          format: int64
          nullable: true
          description: >-
            The smallest duration in milliseconds of all completed process
            instances which were started in the given period.
        maximum:
          type: integer
          format: int64
          nullable: true
          description: >-
            The greatest duration in milliseconds of all completed process
            instances which were started in the given period.
        average:
          type: integer
          format: int64
          nullable: true
          description: >-
            The average duration in milliseconds of all completed process
            instances which were started in the given period.
    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

````