License consumption by projects - ABBYY Documentation

License Consumption by Projects reports show the number of pages consumed by each project during the reporting period. The data is aggregated into 24-hour periods and covers only the pages consumed by running Processing Stations. For more information about the data these reports collect, see License Consumption by Projects.

Parameters

Name	Corresponding UI option	Type	Description
`projectIds`	Projects	`string`	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.
`tenantIds`	Tenants	`string`	Specifies the tenants to collect license consumption data for. Possible values: `null` (all available tenants), `0` (the default tenant only), `1` or greater (the tenant with the specified ID only). The default value is `null`.
`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.
`batchTypeIds`	Batch types	`string`	List of batch type IDs to generate the report for. Use the GetBatchTypes method to get information about all batch types in a project. The default value is `null`, which includes data for all batch types.
`aggregateByBatchTypes`	Batch types	`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` (day), `2` (week), `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": "projectIds", "Value": "1;2" },
    { "Name": "batchTypeIds", "Value": "1" },
    { "Name": "aggregateByBatchTypes", "Value": true },
    { "Name": "groupByType", "Value": 1 }
]