Reporting

Get

get

Retrieve the Reporting Settings.

Responses
200
Success
application/json; api-version=1.0
get
GET /api/Reporting HTTP/1.1
Host: 
Accept: */*
{
  "enabled": true,
  "deltaCpu": 1,
  "deltaMemory": 1,
  "enableCustomReports": true,
  "folderName": "text",
  "port": 1,
  "server": "text",
  "useCredentials": true,
  "username": "text",
  "trackServerTime": 1,
  "trackServers": true,
  "trackSessionTime": 1,
  "trackSessions": true,
  "trackLogonDetails": true,
  "trackLogonDetailsTime": 1,
  "trackUserExperience": true,
  "trackUserExperienceTime": 1,
  "deltaUXEvaluator": 1,
  "deltaLatency": 1,
  "deltaBandwidth": 1
}

Update

put

Modify the Reporting Settings.

Body

Update RAS Reporting settings

enabledboolean | nullableOptional

Enable or disable RAS Reporting functionality.

deltaCpuinteger · int32 | nullableOptional

Minimum CPU change required to track the counter.

deltaMemoryinteger · int32 | nullableOptional

Minimum Memory change required to track the counter.

enableCustomReportsboolean | nullableOptional

Enable or disable custom report.

folderNamestring | nullableOptional

Custom report folder name.

portinteger · int32 | nullableOptional

Port used by the service which receives data from the RAS Connection Broker. The default port is 30008.

serverstring | nullableOptional

The FQDN or IP address of the server where RAS Reporting is installed.

useCredentialsboolean | nullableOptional

Enable or disable Username/Password credentials to connect to the Server hosting RAS Reporting.

usernamestring | nullableOptional

Username to connect to the Server hosting RAS Reporting (if UseCredentials is enabled).

passwordstring | nullableOptional

Password to connect to the Server hosting RAS Reporting (if UseCredentials is enabled).

trackServerTimeinteger · int32 | nullableOptional

How long the server counters information (such as CPU, Memory and number of sessions) is kept (in seconds).

trackServersboolean | nullableOptional

Enable or disable Server counters information tracking.

trackSessionTimeinteger · int32 | nullableOptional

How long information regarding the sessions opened is kept (in seconds).

trackSessionsboolean | nullableOptional

Enable or disable Sessions information tracking.

trackLogonDetailsboolean | nullableOptional

Enable or disable Logon information tracking.

trackLogonDetailsTimeinteger · int32 | nullableOptional

How long information regarding the logon is kept (in seconds).

trackUserExperienceboolean | nullableOptional

Enable or disable User experience tracking.

trackUserExperienceTimeinteger · int32 | nullableOptional

How long information regarding the user experience is kept (in seconds).

deltaUXEvaluatorinteger · int32 | nullableOptional

Track UX Evaluator when change is more than user input.

deltaLatencyinteger · int32 | nullableOptional

Track Delta latency when change is more than user input.

deltaBandwidthinteger · int32 | nullableOptional

Track Delta bandwidth when change is more than user input.

Responses
204
No Content
put
PUT /api/Reporting HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 420

{
  "enabled": true,
  "deltaCpu": 1,
  "deltaMemory": 1,
  "enableCustomReports": true,
  "folderName": "text",
  "port": 1,
  "server": "text",
  "useCredentials": true,
  "username": "text",
  "password": "text",
  "trackServerTime": 1,
  "trackServers": true,
  "trackSessionTime": 1,
  "trackSessions": true,
  "trackLogonDetails": true,
  "trackLogonDetailsTime": 1,
  "trackUserExperience": true,
  "trackUserExperienceTime": 1,
  "deltaUXEvaluator": 1,
  "deltaLatency": 1,
  "deltaBandwidth": 1
}

No content

Last updated

Was this helpful?