General Operator reports - ABBYY Documentation

General Operator reports measure the productivity of each operator involved in the manual processing stages. For more information about the data these reports collect, see General Operator reports.

Parameters

Name	Corresponding UI option	Type	Description
`users`	Operators	`int array`	List of user IDs to generate the report for. Use the GetAvailableUsers method to get information about available users. The default value is `null`, which includes data for all users.
`roles`	Roles	`int array`	List of operator roles to generate the report for. For possible values, see RoleType. The default value is `null`, which includes data for all roles.
`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.
`projects`	Projects	`int array`	List of project IDs to generate the report for. Use the GetProjects method to get information about all projects on the Application Server. The default value is `null`, which includes data for all projects.
`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.
`batchTypes`	Batch types	`int array`	List of batch type IDs to generate the report for. Use the GetBatchTypes method to get information about all batch types within a project. The default value is `null`, which includes data for all batch types.
`showBatchName`	Batch details	`int`	Includes detailed information about each batch in the report. Possible values: `0` (no), `1` (yes). With `1`, the report gains columns for batch names and the number of pages in each batch. The default value is `0`.
`grouping`	Group by	`string`	Specifies how the report groups the data. Possible values: `UserFullName`, `RoleName`, `ProjectName`, `BatchTypeName`, `StageName`. The default value is `UserFullName`.
`columns`	Show columns	`string array`	List of columns to add to the report. Possible values: `UserId`, `CompletedTasks`, `ToExceptionDocumentCount`, `ToExceptionPageCount`, `ProcessedDocuments`, `ProcessedPages`, `VerifiedFieldsCount`, `VerifiedSymbolsCount`, `CorrectedErrorCount`. The default value is `null`, which adds all possible columns.
`showSummary`	Aggregate report	`boolean`	Specifies whether to generate the aggregate report. Possible values: `0` (no), `1` (yes). The default value is `0`.
`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": "groupByType", "Value": 1 },
    { "Name": "showBatchName", "Value": 0 },
    { "Name": "grouping", "Value": "RoleName" },
    { "Name": "columns", "Value": [ "CompletedTasks", "ProcessedPages" ] },
    { "Name": "users", "Value": [ 1, 2, 3, 7, 10, 12 ] },
    { "Name": "roles", "Value": [ 2, 3, 4 ] },
    { "Name": "projects", "Value": [ 1, 3 ] },
    { "Name": "batchTypes", "Value": [ 1 ] },
    { "Name": "stages", "Value": [ 89, 130 ] }
]