Create Company Usage Report
This parameter can be used in order to activate or deactivate the creation of the company usage report. Before activating this parameter keep in mind, that the creation of the company usage report can take a lot of time.
Technical Name |
create_company_usage_report |
Category |
Functional |
Type |
Boolean (true or false) |
Default Value |
false |
Example Values |
false |
Create Consumption Content Report
This parameter can be used to activate or deactivate the creation of the consumption content report. Before activating this parameter keep in mind, that the creation of the consumption content report can take a lot of time.
Technical Name |
create_consumption_content_report |
Category |
Functional |
Type |
Boolean (true or false) |
Default Value |
false |
Example Values |
false |
Consumption Content Team IDs
This parameter contains a list of team IDs for which to generate the consumption content report.
Technical Name |
consumption_content_team_ids |
Category |
Functional |
Type |
Array |
Default Value |
n/a |
Example Values |
|
Consumption Content User IDs
This parameter contains a list of user IDs for which to generate the consumption content report.
Technical Name |
consumption_content_user_ids |
Category |
Functional |
Type |
Array |
Default Value |
n/a |
Example Values |
|
Create Members Report
This parameter can be used in order to activate or deactivate the creation of the members report. Before activating this parameter keep in mind, that the creation of the members report can take a lot of time.
Technical Name |
create_members_report |
Category |
Functional |
Type |
Boolean (true or false) |
Default Value |
false |
Example Values |
false |
Members Report Team ID
This parameter defines if the member report will only be downloaded for a given team ID.
Technical Name |
members_team_id |
Category |
Functional |
Type |
String null |
Default Value |
null |
Example Values |
null |
Setting this field to null will override the default value.
Create Team Usages Report
This parameter can be used in order to activate or deactivate the creation of the team usages report. Before activating this parameter keep in mind, that the creation of the team usages report can take a lot of time.
Technical Name |
create_team_usages_report |
Category |
Functional |
Type |
Boolean (true or false) |
Default Value |
false |
Example Values |
false |
Team Usages Team IDs
This parameter contains a list of team IDs for which to generate the team usages report.
Technical Name |
team_usages_team_ids |
Category |
Functional |
Type |
Array |
Default Value |
n/a |
Example Values |
|
Create User Usages Report
This parameter can be used in order to activate or deactivate the creation of the user usages report. Before activating this parameter keep in mind, that the creation of the user usages report can take a lot of time.
Technical Name |
create_user_usages_report |
Category |
Functional |
Type |
Boolean (true or false) |
Default Value |
false |
Example Values |
false |
User Usages User IDs
This parameter contains a list of user IDs for which to generate the user usages report.
Technical Name |
user_usages_user_ids |
Category |
Functional |
Type |
Array |
Default Value |
n/a |
Example Values |
|
Company Usage Report Period
This parameter defines the period of time for which the company usage report will be created. The interval needs to be defined using the ISO 8601 norm.
Technical Name |
company_usage_period |
Category |
Functional |
Type |
String |
Default Value |
P30D |
Example Values |
P30D 2020-10-01T14:15Z/2020-11-20T16:00Z 2020-10-01T14:15Z/P2DT5H45M P1DT1H45M/2020-11-01T14:15Z PT21H45M |
|
Be aware: Repeating intervals are not supported! |
Team Usages Period
This parameter defines the period of time for which the team usages report will be created. The interval needs to be defined using the ISO 8601 norm.
Technical Name |
team_usages_period |
Category |
Functional |
Type |
String |
Default Value |
P30D |
Example Values |
P30D 2020-10-01T14:15Z/2020-11-20T16:00Z 2020-10-01T14:15Z/P2DT5H45M P1DT1H45M/2020-11-01T14:15Z PT21H45M |
|
Be aware: Repeating intervals are not supported! |
User Usages Period
This parameter defines the period of time for which the user usages report will be created. The interval needs to be defined using the ISO 8601 norm.
Technical Name |
user_usages_period |
Category |
Functional |
Type |
String |
Default Value |
P30D |
Example Values |
P30D 2020-10-01T14:15Z/2020-11-20T16:00Z 2020-10-01T14:15Z/P2DT5H45M P1DT1H45M/2020-11-01T14:15Z PT21H45M |
|
Be aware: Repeating intervals are not supported! |