> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > Control Panel Operations

REST API - GET Cloud Metrics Reporting Configuration

Updated

This operation returns the configuration for Cloud Metrics Reporting.

Request

Syntax

GET <webservice>/CommServ/MetricsReporting HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Name

Description

Elements

commcellDiagUsage

The option to enable or disable the collection of data for Cloud Metrics Reporting.

Valid values are True or False.

config

id

The ID for the type of data to collect.

service

name

The type of data to collect.

Valid values are:

  • Health Check, collects data for the creation of the Health report

  • Post Upgrade Check, collects data for the creation of the Upgrade Check report

  • Activity, collects data for the creation of the Activity report

  • Upgrade Readiness, collects data for the creation of the Preupgrade Readiness Report

  • Audit, collects data for the creation of the Configuration Audit report

  • Charge Back, collects data for the creation of the Capacity and Charge Back report

  • Proactive Support, allows our Enterprise Support Team to collect log files and other information from your CommCell computer to help you troubleshoot problems

  • Cloud Assist, enables a setup script that creates and configures the user group that is used to send out alerts for Cloud Assist workflows

service

enabled

The option to enable or disable the collection of the type of data in the name parameter.

Valid values are True or False.

serviceList

description

serviceList

flags

serviceList

downloadURL

cloud

uploadURL

cloud

uploadUser

This element is returned, but it has no value because it is not used.

cloud

dataCollectionTime

The time to collect data from the CommServe database.

Valid values are UNIX-style timestamps (seconds since January 1, 1970). For example, if 3:30 p.m. is set as the data collection time, 55800 is the value in the dataCollectionTime parameter.

config

useProxyClient

config

clientGroupId

The system-generated ID assigned to the client computer group. If data is collected for all client computer groups, -1 is the value in the clientGroupId parameter.

clientGroupList

clientGroupName

The client computer group name. If data is collected for all client computer groups, the clientGroupName parameter is not returned.

clientGroupList

_type_

Valid value is CLIENT_GROUP_ENTITY.

clientGroupList

metricsReportPackageInstalled

Indicates whether the Metrics Reporting Server package is installed in the CommCell environment or not.

Valid values are True or False.

config

uploadNow

This element is returned, but it has no value because it is not used.

config

lastCollectionTime

The date and time the data was collected from the CommServe database.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

config

lastUploadTime

The date and time the data was uploaded to the Metrics Reporting Server.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

config

uploadFrequency

The number of days between the time that data collection results are uploaded to the Metrics Reporting Server.

Valid values are 1 to 7.

config

nextUploadTime

The next date and time the data will be uploaded to the Metrics Reporting Server.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

config

tieringActive

This element is returned, but it has no value because it is not used.

config

CCIDs

This element is returned, but it has no value because it is not used.

ScrubCommCells

QueryIds

This element is returned, but it has no value because it is not used.

RestrictQuery

Examples

Sample Request

GET <webservice>/CommServ/MetricsReporting HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <EVGui_GetCommServeSurveyConfigurationResp>
   <config>
     <commcellDiagUsage>true</commcellDiagUsage>
     <cloud>
       <serviceList>
         <service>
           <id>1</id>
           <name>Health Check</name>
         </service>
         <enabled>false</enabled>
         <description></description>
         <flags>0</flags>
       </serviceList>
       <serviceList>
         <service>
           <id>2</id>
           <name>Post Upgrade Check</name>
         </service>
         <enabled>true</enabled>
         <description></description>
         <flags>0</flags>
       </serviceList>
       <serviceList>
         <service>
           <id>3</id>
           <name>Activity</name>
         </service>
         <enabled>false</enabled>
         <description></description>
         <flags>0</flags>
       </serviceList>
       <serviceList>
         <service>
           <id>4</id>
           <name>Upgrade Readiness</name>
         </service>
         <enabled>false</enabled>
         <description></description>
         <flags>1</flags>
       </serviceList>
       <serviceList>
         <service>
           <id>5</id>
           <name>Audit</name>
         </service>
         <enabled>false</enabled>
         <description></description>
         <flags>0</flags>
       </serviceList>
       <serviceList>
         <service>
           <id>6</id>
           <name>Charge Back</name>
         </service>
         <enabled>true</enabled>
         <description></description>
         <flags>144</flags>
       </serviceList>
       <serviceList>
         <service>
           <id>7</id>
           <name>Proactive Support</name>
         </service>
         <enabled>true</enabled>
         <description></description>
         <flags>1</flags>
       </serviceList>
       <serviceList>
         <service>
           <id>8</id>
           <name>Cloud Assist</name>
         </service>
         <enabled>true</enabled>
         <description></description>
         <flags>1</flags>
       </serviceList>
       <downloadURL></downloadURL>
       <uploadURL></uploadURL>
       <uploadUser/>
     </cloud>
     <dataCollectionTime>25200</dataCollectionTime>
     <useProxyClient>false</useProxyClient>
     <clientGroupList>
       <clientGroupId>-1</clientGroupId>
       <_type_>CLIENT_GROUP_ENTITY</_type_>
     </clientGroupList>
     <metricsReportPackageInstalled>false</metricsReportPackageInstalled>
     <uploadNow>0</uploadNow>
     <lastCollectionTime>0</lastCollectionTime>
     <lastUploadTime>1493415159</lastUploadTime>
     <uploadFrequency>7</uploadFrequency>
     <nextUploadTime>1502881200</nextUploadTime>
     <tieringActive>false</tieringActive>
     <HttpServerInfo>
       <ScrubCommCells>
         <CCIDs></CCIDs>
       </ScrubCommCells>
       <RestrictQuery>
         <QueryIds></QueryIds>
       </RestrictQuery>
     </HttpServerInfo>
   </config>
 </EVGui_GetCommServeSurveyConfigurationResp>