Skip to main content
GET
/
v2.0
/
auditevents
/
{auditEventId}
Get an audit event
curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/auditevents/{auditEventId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "timestamp": "2020-04-27T14:22:11.000Z",
  "type": "create",
  "user": "[email protected]",
  "modifiedResources": [
    {
      "resourceId": "5e997f0cdcfc57730cf32941",
      "resourceType": "node"
    }
  ],
  "payload": {
    "name": "new resource name"
  }
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
api_key
string
query
required

Supply the API Key in the Url-Query

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
auditEventId
string
required

Audit event ID

Response

Returns audit event object

​
id
string
Required string length: 24
​
timestamp
string

The timestamp when the action happened

Example:

"2020-04-27T14:22:11.000Z"

​
type
enum<string>

The type of operation that was performed

Available options:
action,
create,
replace,
patch,
delete,
authentication,
authorization
Example:

"create"

​
user
string

The email of the user who performed the operation

Example:

"[email protected]"

​
modifiedResources
object[]

An list of resources in the chain of the modification

​
payload
object

The raw payload of the operation in case it was tracked

Example:
{ "name": "new resource name" }