RIringcentral
Audit Trail

Search Audit Trail Data

Returns the audit trail data with specific filters applied. Audit trail searching is limited to the last 10,000 records or last 180 days, whichever comes first.

post/restapi/v1.0/account/{accountId}/audit-trail/search

Request

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

Request body

eventTimeFromstring date-time

The beginning of the time range to return records in ISO 8601 format in UTC timezone, default is "eventTimeFrom"-24 hours

eventTimeTostring date-time

The end of the time range to return records in ISO 8601 format in UTC timezone, default is the current time

initiatorIdsstring[]

List of extension IDs of change initiators.

pageinteger

Page number in the result set

perPageinteger

Number of records to be returned per page.

targetIdsstring[]

List of extension (user) IDs affected by this action.

siteIdstring

Site ID to apply as a filter

actionIdsstring[]

List of action IDs (exact keys) to search for (alternatively "excludeActionIds" option can be used).

searchStringstring

The (sub)string to search, applied to the following fields:

  • initiator.name
  • initiator.role
  • initiator.extensionNumber
  • target.name
  • target.extensionNumber
  • details.parameters.value
excludeActionIdsstring[]

List of action IDs (exact keys) to exclude from your search (alternatively "actionIds" option can be used).

Example request

{
  "page": 1,
  "perPage": 25,
  "targetIds": [
    "404611540004"
  ],
  "siteId": "871836004",
  "actionIds": [
    "CHANGE_SECRET_INFO",
    "CHANGE_USER_INFO"
  ],
  "searchString": "542617",
  "excludeActionIds": [
    "CHANGE_SECRET_INFO",
    "CHANGE_USER_INFO"
  ]
}

Response

List of Account History Records

Example response

{
  "records": [
    {
      "id": "9835bead-397b-4ba8-b457-73f07ab79997",
      "initiator": {
        "extensionId": "402539300008",
        "extensionNumber": "101",
        "name": "Alice Smith",
        "role": "Super Admin"
      },
      "actionId": "CHANGE_SECRET_INFO",
      "eventType": "UPDATE",
      "accountId": "403858014008",
      "accountName": "Some Company",
      "target": {
        "objectId": "404611540004",
        "objectType": "Extension",
        "name": "Charlie Williams",
        "extensionNumber": "103",
        "siteId": "871836004"
      },
      "clientIp": "192.168.42.6",
      "details": {
        "parameters": [
          {
            "key": "settingName",
            "value": "Password"
          }
        ]
      }
    }
  ],
  "paging": {
    "perPage": 50,
    "total": 25,
    "totalFound": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.