> ## 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 of completed tasks. When the report type is set to `count`, the report contains a list of completed task counts where an entry contains the task name, the definition key of the task, the process definition id, the process definition key, the process definition name and the count of how many tasks were completed for the specified key in a given period. When the report type is set to `duration`, the report contains a minimum, maximum and average duration value of all completed task instances in a given period. ## OpenAPI ````yaml GET /history/task/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/task/report: get: tags: - Historic Task Instance summary: Get Task Report (Historic) description: >- Retrieves a report of completed tasks. When the report type is set to `count`, the report contains a list of completed task counts where an entry contains the task name, the definition key of the task, the process definition id, the process definition key, the process definition name and the count of how many tasks were completed for the specified key in a given period. When the report type is set to `duration`, the report contains a minimum, maximum and average duration value of all completed task instances in a given period. operationId: getHistoricTaskInstanceReport parameters: - name: reportType in: query schema: enum: - duration - count type: string description: >- **Mandatory.** Specifies the kind of the report to execute. To retrieve a report about the duration of process instances the value must be set to `duration`. For a report of the completed tasks in a specific timespan the value must be set to `count`. - name: periodUnit in: query schema: enum: - MONTH - QUARTER type: string description: >- When the report type is set to `duration`, this parameter is **mandatory**. Specifies the granularity of the report. Valid values are `month` and `quarter`. - name: completedBefore in: query schema: type: string format: date-time description: >- Restrict to tasks that were completed before 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., `2013-01-23T14:42:45.000+0200`. - name: completedAfter in: query schema: type: string format: date-time description: >- Restrict to tasks that were completed 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., `2013-01-23T14:42:45.000+0200`. - name: groupBy in: query schema: type: string description: >- When the report type is set to `count`, this parameter is **mandatory**. Groups the tasks report by a given criterion. Valid values are `taskName` and `processDefinition`. responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/HistoricTaskInstanceReportResultDto' examples: example-1: summary: Request for completed task report description: >- GET `/history/task/report?reportType=count&groupBy=processDefinition` value: - taskName: null processDefinitionId: aProcessDefinitionId processDefinitionKey: aProcessDefinitionKey processDefinitionName: A Process Definition Name count: 42 - taskName: null processDefinitionId: anotherProcessDefinitionId processDefinitionKey: anotherProcessDefinitionKey processDefinitionName: Another Process Definition Name count: 9000 example-2: summary: Request for duration report. description: >- GET `/history/task/report?reportType=duration&periodUnit=quarter` 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 description: Request successful. '400': content: application/json: schema: $ref: '#/components/schemas/ExceptionDto' description: >- Returned if some of the query parameters are invalid, for example if a `completedAfter` parameter is supplied, but the date format is wrong. See the [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling) for the error response format. components: schemas: HistoricTaskInstanceReportResultDto: type: object properties: taskName: type: string nullable: true description: >- The name of the task. It is only available when the `groupBy` parameter is set to `taskName`. Else the value is `null`. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`. count: type: integer format: int64 nullable: true description: >- The number of tasks which have the given definition. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`. processDefinitionKey: type: string nullable: true description: >- The key of the process definition. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`. processDefinitionId: type: string nullable: true description: >- The id of the process definition. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`. processDefinitionName: type: string nullable: true description: >- The name of the process definition. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`. period: type: integer format: int32 nullable: true description: >- Specifies a span of time within a year. **Note:** The period must be interpreted in conjunction with the returned `periodUnit`. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`. periodUnit: type: string nullable: true enum: - MONTH - QUARTER description: >- The unit of the given period. Possible values are `MONTH` and `QUARTER`. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`. 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. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`. 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. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`. 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. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`. tenantId: type: string nullable: true description: The id of the tenant. 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 ````