Site Performance reports - ABBYY Documentation

Site Performance reports assess the performance of ABBYY FlexiCapture and of individual tenants. For more information about the data these reports collect, see Performance reports.

Parameters

Name	Corresponding UI option	Type	Description
`tenantIds`	Tenants	`string`	List of tenant IDs to generate the report for. The default value is `null`, which includes data for all tenants.
`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.
`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": "tenantIds", "Value": "1;2" },
    { "Name": "groupByType", "Value": 1 }
]