Get the list of changed settings within a specific duration of time, useful for auditing purposes.
Permission required: can-audit.
Changelog
| Version | Description |
|---|---|
| 7.5.0 | Added |
The user ID.
The authentication token.
Enter the start of the time period for which you want to view the changed settings. Format: DD-MM-YYYY or use the ISO string format.
Enter the start of the time period for which you want to view the changed settings. Format: DD-MM-YYYY or use the ISO string format.
Enter the setting ID for which you want to view the details.
Filter the results by the user details that performed the action.
The type value can be one of the following:
- The
userwho changed the setting - The
system, for example, when theactorwas the server itself, like when the license changes through cloud. - An
appdue to which a setting was changed.
The user or app ID that changed the setting (when the type is user or app).
The username of the user who changed the setting (when the type is user).
The IP address using which settings were changed (when the type is user).
The device details of the user who changed the setting (when the type is user).
The reason of the changed setting (when the type is setting or app).
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}. Refer to the official documentation to learn more.
OK
{
"events": [
{
"_id": "67e431efaae4c3005ea54c73",
"t": "settings.changed",
"ts": "2025-03-26T16:57:19.671Z",
"actor": {
"type": "user",
"_id": "P2dgWPPw5veigwcdK",
"username": "fun.abc",
"ip": "154.113.158.225",
"useragent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36"
},
"data": [
{
"key": "id",
"value": "Omnichannel_allow_force_close_conversations"
},
{
"key": "previous",
"value": false
},
{
"key": "current",
"value": true
}
],
"ip": "154.113.158.225",
"u": {
"_id": "P2dgWPPw5veigwcdK",
"username": "fun.abc"
},
"_updatedAt": "2025-03-26T16:57:19.671Z"
},
{
"_id": "67e3ec90aae4c3005ea54bbe",
"t": "settings.changed",
"ts": "2025-03-26T12:01:20.322Z",
"actor": {
"type": "system",
"reason": "cacheValueInSettings reset"
},
"data": [
{
"key": "id",
"value": "Cloud_Workspace_Supported_Versions_Token"
},
{
"key": "previous",
"value": "eyJhbGciOiJSUzI1NiIsInR4MkwVVhy3JQ2fQ"
},
{
"key": "current",
"value": "eyJhbGciOiJSUz9Sw"
}
],
"ip": "0.0.0.0",
"_updatedAt": "2025-03-26T12:01:20.322Z"
},
{
"_id": "67e3ec77aae4c3005ea54bbd",
"t": "settings.changed",
"ts": "2025-03-26T12:00:55.126Z",
"actor": {
"type": "system",
"reason": "cacheValueInSettings reset"
},
"data": [
{
"key": "id",
"value": "Cloud_Workspace_Supported_Versions_Token"
},
{
"key": "previous",
"value": "eyJhVVhy3JQ2fQ"
},
{
"key": "current",
"value": "eyJhbGhy3JQ2fQ"
}
],
"ip": "0.0.0.0",
"_updatedAt": "2025-03-26T12:00:55.126Z"
},
{
"_id": "67e3ec63aae4c3005ea54bbc",
"t": "settings.changed",
"ts": "2025-03-26T12:00:35.117Z",
"actor": {
"type": "system",
"reason": "cacheValueInSettings reset"
},
"data": [
{
"key": "id",
"value": "Cloud_Workspace_Supported_Versions_Token"
},
{
"key": "previous",
"value": "eyJhbGciOhy3JQ2fQ"
},
{
"key": "current",
"value": "eyJhbGciOiy3JQ2fQ"
}
],
"ip": "0.0.0.0",
"_updatedAt": "2025-03-26T12:00:35.117Z"
},
{
"_id": "67e3ec54aae4c3005ea54bbb",
"t": "settings.changed",
"ts": "2025-03-26T12:00:20.098Z",
"actor": {
"type": "system",
"reason": "cacheValueInSettings reset"
},
"data": [
{
"key": "id",
"value": "Cloud_Workspace_Supported_Versions_Token"
},
{
"key": "previous",
"value": "eyJhbGciOiJyD0Cw"
},
{
"key": "current",
"value": "eyJhbwVVhy3JQ2fQ"
}
],
"ip": "0.0.0.0",
"_updatedAt": "2025-03-26T12:00:20.098Z"
}
],
"count": 5,
"offset": 0,
"total": 20,
"success": true
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}