Skip to main content
License Consumption by Projects reports show the number of pages consumed by each project during the reporting period. License consumption data are aggregated into 24-hour periods and only include pages consumed as a result of running Processing Stations. For detailed information about data collected by reports, please see License Consumption by Projects.

​
Parameters

Name

Corresponding UI option

Type

Description

projectIds

Projects

string

List of project IDs for which the report should be generated. Use GetProjects method to get information about all the projects on the Application Server. The default value is null, which means that data for all projects will be included in the report.

tenantIds

Tenants

string

Specifies the tenants for which license consumption data should be collected. Possible values are:

  • Null – license consumption data will be collected for all available tenants.
  • 0 – license consumption data will be collected only for the default tenant.
  • 1 and greater – license consumption data will be collected only for the tenant with the specified ID.

The default value is null.

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

Tenants

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.

batchTypeIds

Batch types

string

List of batch type IDs for which the report should be generated. Use the GetBatchTypes method to get information about all batch types in a project. The default value is null, which means that data for all batch types will be included in the report.

aggregateByBatchTypes

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