Skip to main content
You can use the Web API to download reports on operator workloads, processed documents, documents from specific clients, and other criteria. The API method parameters and the resulting CSV file are identical to those produced when you create reports in the Administration and Monitoring Console. For more information, see Reports. To download reports, use a GET request with the following URI:

Request parameters

Pass reportType and filterParametersJson in the query string.

Report types

reportType accepts the following values:
ValueReport
1General Operators report
3Processing Performance report
9Site Performance report
10License Consumption by Tenants report
11License Consumption by Projects report

Report parameters

filterParametersJson accepts the parameters used to generate the report. The set of parameters depends on the report type. For more information, see the parameters for each report type:

Example script

The following PowerShell script demonstrates how to use this API to download a report.