Skip to main content
Site Performance reports are used to assess the performance of ABBYY FlexiCapture and individual tenants. For detailed information about various data collected by reports, please see Performance reports.

​
Parameters

Name

Corresponding UI option

Type

Description

tenantIds

Tenants

string

List of tenant IDs for which the report should be generated. The default value is null, which means that data for all tenants will be included in the report.

dateFrom

Interval

datetime

Date and time of the beginning of the time interval for which the report should be generated. The default value is calculated using the following formula: “date and time at the moment of the report generation minus one day”.

dateTo

datetime

Date and time of the end of the time interval for which the report should be generated. The default value is the date and time at the moment of the report generation.

columns

Show columns

string array

List of columns that should be added to the report. Possible values are:

  • TenantName
  • PagesOut
  • PagesIn
  • PagesAutoOut
  • PagesHandOut
  • PagesAutoQueue
  • PagesHandQueue
  • Sessions

The default value is null, which means that all possible columns will be added to the report.

showSummary

Aggregate report

boolean

Specifies whether the aggregate report should be generated. Possible values are:

  • true
  • false

The default value is false.

groupByType

Time period

int

The time period by which the data will be grouped in the report. Possible values are:

  • 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 } ]