Reporting

Get

Retrieve the Reporting Settings.

GET/api/Reporting

Response

Success

Body

enabledboolean

Enable or disable RAS Reporting functionality.

deltaCpuinteger (int32)

Minimum CPU change required to track the counter.

deltaMemoryinteger (int32)

Minimum Memory change required to track the counter.

enableCustomReportsboolean

Enable or disable custom report.

folderNamenullable string

Custom report folder name.

portinteger (int32)

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

servernullable string

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

useCredentialsboolean

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

usernamenullable string

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

trackServerTimeinteger (int32)

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

trackServersboolean

Enable or disable Server counters information tracking.

trackSessionTimeinteger (int32)

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

trackSessionsboolean

Enable or disable Sessions information tracking.

trackLogonDetailsboolean

Enable or disable logon details tracking.

trackLogonDetailsTimeinteger (int32)

How long to retain logon details.

trackUserExperienceboolean

Enable or disable tracking of user experience data.

trackUserExperienceTimeinteger (int32)

How long to retain user experience data.

deltaUXEvaluatorinteger (int32)

Track UX evaluator by user percentage choice.

deltaLatencyinteger (int32)

Track Latency by user percentage choice.

deltaBandwidthinteger (int32)

Track bandwidth by user percentage choice.

Request

const response = await fetch('/api/Reporting', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Update

Modify the Reporting Settings.

PUT/api/Reporting

Body

Reporting Configuration Settings model

enablednullable boolean

Enable or disable RAS Reporting functionality.

deltaCpunullable integer (int32)

Minimum CPU change required to track the counter.

deltaMemorynullable integer (int32)

Minimum Memory change required to track the counter.

enableCustomReportsnullable boolean

Enable or disable custom report.

folderNamenullable string

Custom report folder name.

portnullable integer (int32)

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

servernullable string

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

useCredentialsnullable boolean

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

usernamenullable string

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

passwordnullable string

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

trackServerTimenullable integer (int32)

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

trackServersnullable boolean

Enable or disable Server counters information tracking.

trackSessionTimenullable integer (int32)

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

trackSessionsnullable boolean

Enable or disable Sessions information tracking.

trackLogonDetailsnullable boolean

Enable or disable Logon information tracking.

trackLogonDetailsTimenullable integer (int32)

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

trackUserExperiencenullable boolean

Enable or disable User experience tracking.

trackUserExperienceTimenullable integer (int32)

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

deltaUXEvaluatornullable integer (int32)

Track UX Evaluator when change is more than user input.

deltaLatencynullable integer (int32)

Track Delta latency when change is more than user input.

deltaBandwidthnullable integer (int32)

Track Delta bandwidth when change is more than user input.

Response

No Content

Request

const response = await fetch('/api/Reporting', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

PreviousPerformance Monitor NextSettings

Last updated 9 months ago

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

const response = await fetch('/api/Reporting', { method: 'PUT', headers: { "Content-Type": "application/json; api-version=1.0" }, body: JSON.stringify({}), }); const data = await response.json();