Processing Performance reports - ABBYY Documentation

Processing Performance reports calculate the processing performance. For more information about the data these reports collect, see Processing reports.

Parameters

Name	Corresponding UI option	Type	Description
`projects`	Projects	`int array`	List of project IDs to generate the report for. Use the GetProjects method to get information about all the projects on the Application Server. The default value is `null`, which includes data for all projects.
`dateFrom`	Interval	`datetime`	Date and time when the reporting interval begins. The default value is the date and time when the report is generated, minus one day.
`dateTo`	Interval	`datetime`	Date and time when the reporting interval ends. The default value is the date and time when the report is generated.
`batchTypes`	Batch types	`int array`	List of batch type IDs to generate the report for. Use the GetBatchTypes method to get information about all the batch types within a project. The default value is `null`, which includes data for all batch types.
`stages`	Stages	`int array`	List of stages to generate the report for. For possible values, see ProcessingStageType. The default value is `null`, which includes data for all stages.
`grouping`	Group by	`string`	Specifies how the report groups the data. Possible values: `ProjectName`, `BatchTypeName`, `ProcessingStageName`. The default value is `ProjectName`.
`columns`	Show columns	`string array`	List of columns to add to the report. Possible values: `TenantName`, `PagesOut`, `PagesIn`, `PagesAutoOut`, `PagesHandOut`, `PagesAutoQueue`, `PagesHandQueue`, `Sessions`. The default value is `null`, which adds all possible columns.
`showSummary`	Aggregate report	`boolean`	Specifies whether to generate the aggregate report. Possible values: `true`, `false`. The default value is `false`.
`groupByType`	Time period	`int`	The time period by which the report groups the data. Possible values: `1` (hour), `2` (day), `3` (month). The default value is `1`.

Example

[
    { "Name": "dateFrom", "Value": "2021-10-31T21:00:00.000Z" },
    { "Name": "dateTo", "Value": "2022-04-05T21:00:00.000Z" },
    { "Name": "projects", "Value": [ 1, 2, 3, 4, 5, 6, 7 ] },
    { "Name": "batchTypes", "Value": [ 1 ] },
    { "Name": "aggregateByBatchTypes", "Value": true },
    { "Name": "groupByType", "Value": 1 },
    { "Name": "grouping", "Value": "ProcessingStageName" },
    { "Name": "columns", "Value": [ "ProjectId", "BatchTypeName", "ProcessedBatchs", "ProcessedDocs" ] },
    { "Name": "stages", "Value": [ 60, 50 ] }
]