Reporting

Get

get

Retrieve the Reporting Settings.

Responses
chevron-right
200

Success

application/json; api-version=1.0
get
/api/Reporting

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 · min: 1 · max: 255 · 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
put
/api/Reporting

No content

Was this helpful?