> For the complete documentation index, see [llms.txt](https://docs-en.dydu.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-en.dydu.ai/developers/api-reference/server-status-api.md).

# Server Status API

The server status API gives the status of your platform and its applications. It is useful for monitoring.

## Send a request

* **Address**: `https://<server>/servlet/api/serverstatus`, replacing `<server>` with the address of your platform.
* **Method**: `GET`.
* **Authentication**: none.

You can also test it in the Swagger interface: go to **Preferences > Api > API access**, click the link provided, then **Server status** and **GET /serverstatus**.

| Parameter    | Required | Description                                                                                                                             |
| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `details`    | No       | `true` to get detailed information about each application.                                                                              |
| `pretty`     | No       | `true` to get a formatted, more readable JSON response.                                                                                 |
| `httpstatus` | No       | `true` for the API to return the HTTP **503** code when the server status is neither "Ok" nor "Warning". Useful for a monitoring probe. |
| `callback`   | No       | Name of a JavaScript function, to receive the response in JSONP format.                                                                 |

curl request:

```
curl -X GET "https://<server>/servlet/api/serverstatus?details=true&pretty=true" -H "accept: application/json"
```

Response (extract):

```
{
  "withDetails": true,
  "volumes": {
    "connectedPeople": 9,
    "connectedOperators": 3,
    "currentDialogs": 273,
    "currentLivechatDialogs": 1
  },
  "applications": {
    "runtime": { "status": "Ok", "durationMs": 40 },
    "dialog": { "status": "Ok", "durationMs": 60 },
    "slogger": { "status": "Ok", "durationMs": 33 },
    "website": { "status": "Ok", "durationMs": 54, "customs": { "sessions": 16 } },
    "servlet": { "status": "Ok", "durationMs": 62, "customs": { "sessions": 0 } },
    "database": { "status": "Ok", "durationMs": 5 },
    "livechat": { "status": "Ok", "durationMs": 11, "customs": { "sessions": 168 } }
  },
  "status": "Ok",
  "hostName": "app1.earth.doyoudreamup.com",
  "date": "2026-11-16 17:40:49",
  "version": "...",
  "durationMs": 61
}
```

The result is cached for one second.

## Read the response

### Server status

The **status** field gives the overall status of the server. This is the value to monitor.

| Value     | Meaning                                                      |
| --------- | ------------------------------------------------------------ |
| `Ok`      | The server is working normally.                              |
| `Warning` | The server is working, but an application reports a problem. |
| `Error`   | The server has an error.                                     |
| `Unknown` | The server status could not be determined.                   |

### Volumes

The **volumes** object gives the current activity:

* `connectedPeople`: number of BMS users who performed an action in the last 10 minutes;
* `connectedOperators`: number of connected livechat operators;
* `currentDialogs`: number of ongoing dialogs;
* `currentLivechatDialogs`: number of ongoing livechat dialogs.

The `-1` value means that the information could not be retrieved.

### Applications

The **applications** object gives the status of each application of the server: `runtime`, `dialog`, `slogger`, `website`, `servlet`, `database` and `livechat`. The `status` field of each application can be:

| Value            | Meaning                                                                                                           |
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
| `Ok`             | The application is working normally.                                                                              |
| `Warning`        | The application reports a problem. For `servlet`, more than 2% of dialog requests failed over the last 5 minutes. |
| `Ko`             | The application is not working. For `servlet`, more than 90% of dialog requests failed over the last 5 minutes.   |
| `Disabled`       | The application is disabled (for example `livechat` when the livechat is not enabled).                            |
| `NotImplemented` | The check is not available for this application.                                                                  |
| `Unknown`        | The application status could not be determined.                                                                   |

{% hint style="info" %}
The `durationMs` fields give the time needed to retrieve each piece of information. They are for information only.
{% endhint %}
