Share this page
Admin reports
You can generate an admin report to collect system usage data, such as the number of active and inactive projects and size of repositories and database.
Admin report data
An admin report collects the following data.
| Data | Details |
|---|---|
| user-login-activities |
List the inactive users who have not logged in during the past specified days.
If a user has never logged in, only the username is returned. |
| projects-ping-result |
Lists the projects that have been pinged and the ping result of each project.
|
| projects-last-login-activity |
Lists the last login time of each project.
|
| active-sessions |
Lists the amount of active sessions in each project.
|
| projects-repository-size |
Lists the repository size, recyclable size, and file sizes of each project.
|
| projects-db-space-used |
The size of used database space of each project.
|
| project-entities-summary | Lists the number of each type of entity per project. |
Trigger the generation of an admin report
It requires the site administrators permissions to trigger the generation of an admin report.
To trigger the generation of an admin report:
Make the following POST call to trigger an action to generate the admin report.
/qcbin/v2/sa/api/collectors/report-collector/executeRequest example
{
"project-request-option": {
"project-session-connection": {
"fetch-or-not": true,
"is-file-latest": true
},
"project-last-login-activity": {
"fetch-or-not": true,
"is-file-latest": true
},
"project-ping": {
"fetch-or-not": true,
"is-file-latest": true
},
"project-db-space-used": {
"fetch-or-not": true,
"is-file-latest": true
},
"project-entities-summary": {
"fetch-or-not": true,
"is-file-latest": true
},
"project-repository-used-size": {
"fetch-or-not": true,
"is-file-latest": true
},
"user-last-login-activity": {
"fetch-or-not": true,
"is-file-latest": true,
"inactive-days": 1
}
}
}
| Parameter | Description |
|---|---|
| fetch-or-not |
Whether to include the specific data in the admin report. For example, if you set fetch-or-not to true for project-ping-result, the admin report includes the projects ping data. If you set fetch-or-not to false, the admin report does not include the project ping data. |
| is-file-latest |
Works only when fetch-or-not is set to true. It controls whether to check if the data to fetch already exists and if the existing data is up-to-date.
How admin report data is checked for timeliness? For different types of admin report data, the criteria for being considered up-to-date varies:
|
| inactive-days |
Available for: user-last-login-activity only The admin report returns inactive users who have not logged in during the past specified number of days or more. By default, it is 90. Valid values are from 1 to 180 (inclusive). |
Response example
The POST call returns an action ID is an encoded string that contains when the admin report was triggered and how the parameters were set.
{
"report-parameters": {
"report-parameter": "string"
}
}Get an admin report
After the generation of an admin report is triggered, an action ID is returned. You call the following request to get the admin report by the action ID.
GET /qcbin/v2/sa/api/admin-reports/{action-id}Note: It takes time to generate an admin report. Do not get the admin report immediately after you get the action ID. Wait for a while, depending on your project size.
Request header
You can get an admin report in either JSON or CSV format. Specify the format in the Content-Type header: application/json or text/csv.
Response example
{
"admin-reports": {
"user-login-activities": {
"user-activity": [
{
"username": "abatec"
},
{
"username": "adefer2"
},
{
"username": "admanw2"
},
{
"username": "adubio"
},
{
"username": "agarws"
},
{
"username": "aggarr2"
},
{
"username": "alleyt2"
},
{
"username": "arthul2"
},
{
"username": "chowa7"
},
{
"username": "chowad"
},
{
"username": "chrisp4"
},
{
"username": "chum"
},
{
"username": "clykea"
},
{
"username": "codrev2"
},
{
"username": "coffid2"
},
{
"username": "cooksp2"
},
{
"username": "coopej4"
},
{
"username": "coupls2"
},
{
"username": "crawfc3"
},
{
"username": "curtik2"
},
{
"username": "dalems2"
},
{
"username": "dasd2"
},
{
"username": "dattar2"
},
{
"username": "davies3"
},
{
"username": "dd_admin"
},
{
"username": "deanj3"
},
{
"username": "dearir2"
},
{
"username": "debnaa2"
},
{
"username": "dechem"
},
{
"username": "dhanjp2"
},
{
"username": "dickes"
},
{
"username": "dinner2"
}
],
"total-results": 32,
"created-time": 1734319621991,
"inactive-days": 1
},
"projects-ping-result": {
"project-ping-result": [
{
"id": 66,
"project-name": "Ora_Ext_Enabled",
"domain-name": "PROJ_CREATETEST",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 67,
"project-name": "proj_sql_ali",
"domain-name": "PROJ_CREATETEST",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 68,
"project-name": "proj_sql_mc",
"domain-name": "PROJ_CREATETEST",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 69,
"project-name": "proj_sql_pc",
"domain-name": "PROJ_CREATETEST",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 70,
"project-name": "proj_ora_dev",
"domain-name": "PROJ_CREATETEST",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 71,
"project-name": "SQL_1601_SAMPLE",
"domain-name": "NON_FIST_UG_16_01",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 72,
"project-name": "SQL_1601_DEV_EXT",
"domain-name": "NON_FIST_UG_16_01",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 73,
"project-name": "SQL_1601_LAB_EXT",
"domain-name": "NON_FIST_UG_16_01",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 74,
"project-name": "ORACLE_1601_SAMPLE",
"domain-name": "NON_FIST_UG_16_01",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 75,
"project-name": "qc",
"domain-name": "MERCURY",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 76,
"project-name": "ORACLE_1601_ORA_KAISER_HERA",
"domain-name": "NON_FIST_UG_16_01",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 77,
"project-name": "ORACLE_1601_ALI_EXT",
"domain-name": "NON_FIST_UG_16_01",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 78,
"project-name": "ORACLE_1601_EIAM_EXT",
"domain-name": "NON_FIST_UG_16_01",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 81,
"project-name": "iii",
"domain-name": "DEFAULT",
"status": "Active",
"ping-result": "SUCCEEDED"
},
{
"id": 83,
"project-name": "ccc",
"domain-name": "DEFAULT",
"status": "Inactive",
"ping-result": "SUCCEEDED"
}
],
"total-count": 15,
"created-time": 1734318692823
},
"projects-last-login-activity": {
"project-last-login-activity": [
{
"id": 54,
"project-name": "chris_esig_workflow",
"domain-name": "CHRIS",
"last-login-time": 1734319119000
},
{
"id": 60,
"project-name": "Demo",
"domain-name": "DEFAULT",
"last-login-time": 1734309537000
},
{
"id": 62,
"project-name": "esig_v",
"domain-name": "DEFAULT",
"last-login-time": 1734318204000
},
{
"id": 1,
"project-name": "LAB_PROJECT",
"domain-name": "DEFAULT",
"last-login-time": 1734319134000
},
{
"id": 66,
"project-name": "Ora_Ext_Enabled",
"domain-name": "PROJ_CREATETEST",
"last-login-time": 1734318204000
},
{
"id": 77,
"project-name": "ORACLE_1601_ALI_EXT",
"domain-name": "NON_FIST_UG_16_01",
"last-login-time": 1734318204000
},
{
"id": 67,
"project-name": "proj_sql_ali",
"domain-name": "PROJ_CREATETEST",
"last-login-time": 1734318204000
},
{
"id": 75,
"project-name": "qc",
"domain-name": "MERCURY",
"last-login-time": 1734318833000
},
{
"id": 64,
"project-name": "qis_template",
"domain-name": "DEFAULT",
"last-login-time": 1734309568000
},
{
"id": 61,
"project-name": "QIS_TEST",
"domain-name": "DEFAULT",
"last-login-time": 1734317070000
},
{
"id": 65,
"project-name": "Sql_Ext_Enabled",
"domain-name": "PROJ_CREATETEST",
"last-login-time": 1734318204000
},
{
"id": 55,
"project-name": "TDBank_AUTO",
"domain-name": "CUSTOMER_PROJECT",
"last-login-time": 1734309463000
},
{
"id": 56,
"project-name": "TDBank_AUTO_2",
"domain-name": "CUSTOMER_PROJECT",
"last-login-time": 1734309506000
}
],
"total-count": 13,
"created-time": 1734319621952
},
"active-sessions": {
"active-session": [
{
"project-id": 1,
"project-name": "LAB_PROJECT",
"domain-name": "DEFAULT",
"session-info": [
{
"client-type": "ALM Server Internal",
"session-count": 2
},
{
"client-type": "ALM Server Internal - Lab User Context",
"session-count": 2
}
]
},
{
"project-id": 55,
"project-name": "TDBank_AUTO",
"domain-name": "CUSTOMER_PROJECT",
"session-info": [
{
"client-type": "globalsearch",
"session-count": 1
}
]
},
{
"project-id": 56,
"project-name": "TDBank_AUTO_2",
"domain-name": "CUSTOMER_PROJECT",
"session-info": [
{
"client-type": "globalsearch",
"session-count": 1
}
]
},
{
"project-id": 60,
"project-name": "Demo",
"domain-name": "DEFAULT",
"session-info": [
{
"client-type": "globalsearch",
"session-count": 1
}
]
},
{
"project-id": 64,
"project-name": "qis_template",
"domain-name": "DEFAULT",
"session-info": [
{
"client-type": "globalsearch",
"session-count": 1
}
]
},
{
"project-id": 61,
"project-name": "QIS_TEST",
"domain-name": "DEFAULT",
"session-info": [
{
"client-type": "globalsearch",
"session-count": 1
},
{
"client-type": "ALM Web Client UI",
"session-count": 1
}
]
}
],
"total-count": 6,
"created-time": 1734319621938
},
"projects-repository-size": {
"project-repository-size": [
{
"id": 1,
"project-name": "LAB_PROJECT",
"domain-name": "DEFAULT",
"repository-size": 343,
"recyclable-size": 0,
"analysis-item-files-size": 0,
"attach-size": 0,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 0,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 343,
"tests-size": 0
},
{
"id": 54,
"project-name": "chris_esig_workflow",
"domain-name": "CHRIS",
"repository-size": 16629502,
"recyclable-size": 5940,
"analysis-item-files-size": 0,
"attach-size": 15018239,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1593160,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 7801,
"script-templates-size": 4362,
"tests-size": 0
},
{
"id": 55,
"project-name": "TDBank_AUTO",
"domain-name": "CUSTOMER_PROJECT",
"repository-size": 1156849,
"recyclable-size": 5940,
"analysis-item-files-size": 0,
"attach-size": 313052,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 0,
"resources-size": 757591,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 0,
"tests-size": 80266
},
{
"id": 56,
"project-name": "TDBank_AUTO_2",
"domain-name": "CUSTOMER_PROJECT",
"repository-size": 3171988,
"recyclable-size": 25223,
"analysis-item-files-size": 0,
"attach-size": 313052,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1593160,
"resources-size": 388451,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 0,
"tests-size": 852102
},
{
"id": 57,
"project-name": "TDBank_Graph",
"domain-name": "CUSTOMER_PROJECT",
"repository-size": 3191271,
"recyclable-size": 44506,
"analysis-item-files-size": 0,
"attach-size": 313052,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1593160,
"resources-size": 388451,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 0,
"tests-size": 852102
},
{
"id": 58,
"project-name": "15TDBank_T",
"domain-name": "CUSTOMER_PROJECT",
"repository-size": 1660765,
"recyclable-size": 63243,
"analysis-item-files-size": 0,
"attach-size": 0,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1593160,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 4362,
"tests-size": 0
},
{
"id": 59,
"project-name": "15TDBank_T_2",
"domain-name": "CUSTOMER_PROJECT",
"repository-size": 1680048,
"recyclable-size": 82526,
"analysis-item-files-size": 0,
"attach-size": 0,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1593160,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 4362,
"tests-size": 0
},
{
"id": 60,
"project-name": "Demo",
"domain-name": "DEFAULT",
"repository-size": 44486357,
"recyclable-size": 102135,
"analysis-item-files-size": 125836,
"attach-size": 1337479,
"baseline-size": 13439534,
"report-data-size": 0,
"report-templates-size": 1719419,
"resources-size": 1165745,
"results-size": 0,
"runs-size": 0,
"scripts-size": 19951,
"script-templates-size": 4362,
"tests-size": 18308654
},
{
"id": 61,
"project-name": "QIS_TEST",
"domain-name": "DEFAULT",
"repository-size": 1811659,
"recyclable-size": 123901,
"analysis-item-files-size": 0,
"attach-size": 45355,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1591394,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 4362,
"tests-size": 30690
},
{
"id": 62,
"project-name": "esig_v",
"domain-name": "DEFAULT",
"repository-size": 3935962,
"recyclable-size": 142600,
"analysis-item-files-size": 0,
"attach-size": 459174,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 2842762,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 416757,
"script-templates-size": 4362,
"tests-size": 0
},
{
"id": 64,
"project-name": "qis_template",
"domain-name": "DEFAULT",
"repository-size": 1788787,
"recyclable-size": 161285,
"analysis-item-files-size": 0,
"attach-size": 15789,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1591394,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 4362,
"tests-size": 0
},
{
"id": 65,
"project-name": "Sql_Ext_Enabled",
"domain-name": "PROJ_CREATETEST",
"repository-size": 1925590,
"recyclable-size": 161383,
"analysis-item-files-size": 0,
"attach-size": 0,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1755842,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 4362,
"tests-size": 0
},
{
"id": 66,
"project-name": "Ora_Ext_Enabled",
"domain-name": "PROJ_CREATETEST",
"repository-size": 1925688,
"recyclable-size": 161481,
"analysis-item-files-size": 0,
"attach-size": 0,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1755842,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 4362,
"tests-size": 0
},
{
"id": 67,
"project-name": "proj_sql_ali",
"domain-name": "PROJ_CREATETEST",
"repository-size": 1851141,
"recyclable-size": 161481,
"analysis-item-files-size": 0,
"attach-size": 0,
"baseline-size": 0,
"report-data-size": 0,
"report-templates-size": 1685298,
"resources-size": 0,
"results-size": 0,
"runs-size": 0,
"scripts-size": 0,
"script-templates-size": 4362,
"tests-size": 0
}
],
"total-results": 14,
"created-time": 1734318725030
},
"projects-db-space-used": {
"project-db-space-used": [
{
"id": 1,
"project-name": "LAB_PROJECT",
"domain-name": "DEFAULT",
"db-server-name": "mssql_db",
"db-server-type": "MSSQL",
"actual-space-used": 147456
},
{
"id": 8,
"project-name": "ota_permission",
"domain-name": "OTA_PERMISSION",
"db-server-name": "qa-ora-01.aws.swinfra.net_1734124829",
"db-server-type": "ORACLE"
},
{
"id": 10,
"project-name": "excel_auto",
"domain-name": "DEFAULT",
"db-server-name": "qa-ora-01.aws.swinfra.net_1734124829",
"db-server-type": "ORACLE"
},
{
"id": 11,
"project-name": "esig",
"domain-name": "DEFAULT",
"db-server-name": "qa-ora-01.aws.swinfra.net_1734124829",
"db-server-type": "ORACLE"
},
{
"id": 15,
"project-name": "UFT_ALM17P1",
"domain-name": "DEFAULT",
"db-server-name": "qa-ora-01.aws.swinfra.net_1734124829",
"db-server-type": "ORACLE"
},
{
"id": 54,
"project-name": "chris_esig_workflow",
"domain-name": "CHRIS",
"db-server-name": "oracle-restore",
"db-server-type": "ORACLE",
"actual-space-used": 45613056
},
{
"id": 55,
"project-name": "TDBank_AUTO",
"domain-name": "CUSTOMER_PROJECT",
"db-server-name": "qa-sql-001.aws.swinfra.net_1734296795",
"db-server-type": "MSSQL",
"actual-space-used": 1327104
},
{
"id": 56,
"project-name": "TDBank_AUTO_2",
"domain-name": "CUSTOMER_PROJECT",
"db-server-name": "qa-sql-001.aws.swinfra.net_1734296795",
"db-server-type": "MSSQL",
"actual-space-used": 1327104
},
{
"id": 57,
"project-name": "TDBank_Graph",
"domain-name": "CUSTOMER_PROJECT",
"db-server-name": "qa-sql-001.aws.swinfra.net_1734296795",
"db-server-type": "MSSQL",
"actual-space-used": 1327104
},
{
"id": 58,
"project-name": "15TDBank_T",
"domain-name": "CUSTOMER_PROJECT",
"db-server-name": "qa-sql-001.aws.swinfra.net_1734296795",
"db-server-type": "MSSQL",
"actual-space-used": 147456
},
{
"id": 59,
"project-name": "15TDBank_T_2",
"domain-name": "CUSTOMER_PROJECT",
"db-server-name": "qa-sql-001.aws.swinfra.net_1734296795",
"db-server-type": "MSSQL",
"actual-space-used": 147456
},
{
"id": 60,
"project-name": "Demo",
"domain-name": "DEFAULT",
"db-server-name": "qa-ora-01.aws.swinfra.net_1734296795",
"db-server-type": "ORACLE"
},
{
"id": 61,
"project-name": "QIS_TEST",
"domain-name": "DEFAULT",
"db-server-name": "qa-ora-01.aws.swinfra.net_1734296795",
"db-server-type": "ORACLE"
},
{
"id": 62,
"project-name": "esig_v",
"domain-name": "DEFAULT",
"db-server-name": "qa-ora-01.aws.swinfra.net_1734296795",
"db-server-type": "ORACLE"
},
{
"id": 83,
"project-name": "ccc",
"domain-name": "DEFAULT",
"db-server-name": "mssql_db",
"db-server-type": "MSSQL",
"actual-space-used": 147456
}
],
"total-count": 15,
"created-time": 1734318697924
},
"project-entities-summary": {
"project-entities": [
{
"id": 54,
"project-name": "chris_esig_workflow",
"domain-name": "CHRIS",
"test": 1,
"run": 9,
"requirement": 5,
"defect": 3,
"attachment": 15
},
{
"id": 55,
"project-name": "TDBank_AUTO",
"domain-name": "CUSTOMER_PROJECT",
"test": 35230,
"run": 34697,
"requirement": 4738,
"defect": 3813,
"attachment": 18857
},
{
"id": 56,
"project-name": "TDBank_AUTO_2",
"domain-name": "CUSTOMER_PROJECT",
"test": 35230,
"run": 34697,
"requirement": 4738,
"defect": 3813,
"attachment": 18857
},
{
"id": 57,
"project-name": "TDBank_Graph",
"domain-name": "CUSTOMER_PROJECT",
"test": 35230,
"run": 34697,
"requirement": 4738,
"defect": 3807,
"attachment": 18857
},
{
"id": 58,
"project-name": "15TDBank_T",
"domain-name": "CUSTOMER_PROJECT",
"test": 0,
"run": 0,
"requirement": 1,
"defect": 0,
"attachment": 0
},
{
"id": 59,
"project-name": "15TDBank_T_2",
"domain-name": "CUSTOMER_PROJECT",
"test": 0,
"run": 0,
"requirement": 1,
"defect": 0,
"attachment": 0
},
{
"id": 60,
"project-name": "Demo",
"domain-name": "DEFAULT",
"test": 129,
"run": 178,
"requirement": 232,
"defect": 58,
"attachment": 103
},
{
"id": 61,
"project-name": "QIS_TEST",
"domain-name": "DEFAULT",
"test": 11,
"run": 3,
"requirement": 11,
"defect": 34,
"attachment": 18
},
{
"id": 62,
"project-name": "esig_v",
"domain-name": "DEFAULT",
"test": 0,
"run": 0,
"requirement": 1,
"defect": 0,
"attachment": 18
},
{
"id": 64,
"project-name": "qis_template",
"domain-name": "DEFAULT",
"test": 0,
"run": 0,
"requirement": 1,
"defect": 0,
"attachment": 0
},
{
"id": 65,
"project-name": "Sql_Ext_Enabled",
"domain-name": "PROJ_CREATETEST",
"test": 0,
"run": 0,
"requirement": 1,
"defect": 0,
"attachment": 0
},
{
"id": 66,
"project-name": "Ora_Ext_Enabled",
"domain-name": "PROJ_CREATETEST",
"test": 0,
"run": 0,
"requirement": 1,
"defect": 0,
"attachment": 0
},
{
"id": 67,
"project-name": "proj_sql_ali",
"domain-name": "PROJ_CREATETEST",
"test": 0,
"run": 0,
"requirement": 1,
"defect": 0,
"attachment": 0
},
{
"id": 68,
"project-name": "proj_sql_mc",
"domain-name": "PROJ_CREATETEST",
"test": 0,
"run": 0,
"requirement": 1,
"defect": 0,
"attachment": 0
},
{
"id": 83,
"project-name": "ccc",
"domain-name": "DEFAULT",
"test": 0,
"run": 0,
"requirement": 1,
"defect": 0,
"attachment": 0
}
],
"total-count": 15,
"created-time": 1734318716644
}
}
}
See also:
