> ## 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 historic statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances and, optionally, the number of canceled activity instances, finished activity instances and activity instances which completed a scope (i.e., in BPMN 2.0 manner: a scope is completed by an activity instance when the activity instance consumed a token but did not emit a new token). **Note:** This only includes historic data. ## OpenAPI ````yaml GET /history/process-definition/{id}/statistics 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-definition/{id}/statistics: get: tags: - Historic Process Definition summary: Get Historic Activity Statistics description: >- Retrieves historic statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances and, optionally, the number of canceled activity instances, finished activity instances and activity instances which completed a scope (i.e., in BPMN 2.0 manner: a scope is completed by an activity instance when the activity instance consumed a token but did not emit a new token). **Note:** This only includes historic data. operationId: getHistoricActivityStatistics parameters: - name: id in: path schema: type: string required: true description: The id of the process definition. - name: canceled in: query schema: type: boolean description: >- Whether to include the number of canceled activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. - name: finished in: query schema: type: boolean description: >- Whether to include the number of finished activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. - name: completeScope in: query schema: type: boolean description: >- Whether to include the number of activity instances which completed a scope in the result or not. Valid values are `true` or `false`. Default: `false`. - name: incidents in: query schema: type: boolean description: >- Whether to include the number of incidents. Valid values are `true` or `false`. Default: `false`. - name: startedBefore in: query schema: type: string format: date-time description: >- Restrict to process instances that were started 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: startedAfter in: query schema: type: string format: date-time description: >- Restrict to process 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., `2013-01-23T14:42:45.000+0200`. - name: finishedBefore in: query schema: type: string format: date-time description: >- Restrict to process instances that were finished 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: finishedAfter in: query schema: type: string format: date-time description: >- Restrict to process instances that were finished 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: processInstanceIdIn in: query schema: type: string description: >- Restrict to process instances with the given IDs. The IDs must be provided as a comma- separated list. - name: sortBy in: query schema: enum: - activityId type: string description: |- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. - name: sortOrder in: query schema: enum: - asc - desc type: string description: >- Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/HistoricActivityStatisticsDto' examples: example-1: summary: Request With `canceled=true` description: >- GET `history/process-definition/aProcessDefinitionId/statistics?canceled=true` value: - id: anActivity instances: 123 canceled: 50 finished: 0 completeScope: 0 openIncidents: 0 resolvedIncidents: 0 deletedIncidents: 0 - id: anotherActivity instances: 200 canceled: 150 finished: 0 completeScope: 0 openIncidents: 0 resolvedIncidents: 0 deletedIncidents: 0 example-2: summary: Request With `finished=true` description: >- GET `history/process-definition/aProcessDefinitionId/statistics?finished=true` value: - id: anActivity instances: 123 canceled: 0 finished: 20 completeScope: 0 openIncidents: 0 resolvedIncidents: 0 deletedIncidents: 0 - id: anotherActivity instances: 200 canceled: 0 finished: 30 completeScope: 0 openIncidents: 0 resolvedIncidents: 0 deletedIncidents: 0 example-3: summary: Request With `completeScope=true` description: >- GET `history/process-definition/aProcessDefinitionId/statistics?completeScope=true` value: - id: anActivity instances: 123 canceled: 0 finished: 0 completeScope: 20 openIncidents: 0 resolvedIncidents: 0 deletedIncidents: 0 - id: anotherActivity instances: 200 canceled: 0 finished: 0 completeScope: 1 openIncidents: 0 resolvedIncidents: 0 deletedIncidents: 0 description: Request successful. '400': content: application/json: schema: $ref: '#/components/schemas/ExceptionDto' description: >- Returned if some of the query parameters are invalid. See the [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling) for the error response format. components: schemas: HistoricActivityStatisticsDto: type: object properties: id: type: string nullable: true description: The id of the activity the results are aggregated for. instances: type: integer format: int64 nullable: true description: The total number of all running instances of the activity. canceled: type: integer format: int64 nullable: true description: >- The total number of all canceled instances of the activity. **Note:** Will be `0` (not `null`), if canceled activity instances were excluded. finished: type: integer format: int64 nullable: true description: >- The total number of all finished instances of the activity. **Note:** Will be `0` (not `null`), if finished activity instances were excluded. completeScope: type: integer format: int64 nullable: true description: >- The total number of all instances which completed a scope of the activity. **Note:** Will be `0` (not `null`), if activity instances which completed a scope were excluded. openIncidents: type: integer format: int64 nullable: true description: >- The total number of open incidents for the activity. **Note:** Will be `0` (not `null`), if `incidents` is set to `false`. resolvedIncidents: type: integer format: int64 nullable: true description: >- The total number of resolved incidents for the activity. **Note:** Will be `0` (not `null`), if `incidents` is set to `false`. deletedIncidents: type: integer format: int64 nullable: true description: >- The total number of deleted incidents for the activity. **Note:** Will be `0` (not `null`), if `incidents` is set to `false`. 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 ````