Controller 25.2
Controller Reference

# GetStatistics

The `GetStatistics` action returns statistics for the service.

NOTE: This is a service status action that can be sent only by users that belong to an authorization role that allows the `ServiceStatus` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

Each statistic returns in an `autn:stat` XML element. This element contains the following attributes:

class | The group that the statistic belongs to. For example, `Service`.
autnid | The subgroup that the statistic belongs to. For example, `Documents`.
name | The name of the statistic.
metric | The type of statistic. This can have one of the following values: 0 String 1 Bytes 2 Bytes per second 3 per second 4 percent 5 count 6 number 7 timestamp 8 seconds 9 milliseconds 10 maximum 11 megabytes
value | The value of the statistic.

For example:

    <autn:stat class="Service" autnid="Statistics" name="24HourRequestsPerSecond" metric="3" value="8.5" />

In this example, the statistic `24hourRequestsPerSecond` has a value of 8.5 per second.

The following statistics return for all servers:

Class | Statistic | Description
--- | --- | ---
[Service] Class
[Statistics] |
| `ServiceDuration` | The number of seconds the service has been running.
| `10SecondResponseAverage` | The average service response time (in milliseconds) measured over the last 10 seconds.
| `10SecondRequestsPerSecond` | The number of requests to the service per second in the last 10 seconds.
| `10SecondRequests` | The number of requests to the service in the last 60 seconds.
| `60SecondResponseAverage` | The average service response time (in milliseconds) measured over the last 60 seconds.
| `60SecondRequestsPerSecond` | The number of requests to the service per second in the last 60 seconds.
| `60SecondPeakRequestsPerSecond` | The highest number of requests to the service over any 60 second period.
| `60SecondRequests` | The number of requests to the service in the last 60 seconds.
| `1HourResponseAverage` | The average service response time (in milliseconds) measured over the last hour.
| `1HourRequestsPerSecond` | The number of requests to the service per second in the last hour.
| `1HourPeakRequestsPerSecond` | The highest number of requests to the service over any 1 hour period.
| `1HourRequests` | The number of requests to the service in the last hour.
| `24HourResponseAverage` | The average service response time (in milliseconds) measured over the last 24 hours.
| `24HourRequestsPerSecond` | The number of requests to the service per second in the last 24 hours.
| `24HourPeakRequestsPerSecond` | The highest number of requests to the service over any 24 hour period.
| `24HourRequests` | The number of requests to the service in the last 24 hours.
| `RecentResponseAverage` | The average service response time (in milliseconds) from the time the last 10 second period finished to the current time.
| `RecentRequestsPerSecond` | The number of requests to the service per second from the time the last 10 second period finished to the current time.
| `RecentPeakRequestsPerSecond` | The highest number of requests to the service from the time the last 10 second period finished to the current time.
| `RecentRequests` | The number of requests to the service from the time the last 10 second period finished to the current time.
| `TotalRequests` | The total number of requests that were made to the service.

The following statistics return for specific components:

Class | Statistic | Description
--- | --- | ---
[ACI] Class
[Action:`ActionName`]
| `Count` | The total number of `ActionName` actions that were sent to the service.
| `Avg.Duration` | The average duration (in ms) of `ActionName` actions.
| `Shortest` | The shortest duration (in ms) of `ActionName` actions.
| `Longest` | The longest duration (in ms) of `ActionName` actions.
| `Avg.ResponseSize` | The average size of responses (in bytes) for `ActionName` actions.
| `Min.ResponseSize` | The minimum size of a response (in bytes) for `ActionName` actions.
| `Max.ResponseSize` | The maximum size of a response (in bytes) for `ActionName` actions.
[Licensing] Class
[Users]
| `Maximum` | The maximum number of users that can be set up for this service.
[Statistics] Class
[Users]
| `Users` | The number of users that has been set up for this service.

## Example

    action=GetStatistics

## Parameters

None.

Copyright 2015-2025 Open Text
Version 25.2 | Last updated April 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Controller 25.2

Topic Title: GetStatistics