Audit logs
NOTE
Audit logs are only available for users on an Enterprise plan
Retrieve audit logs by making the following request:
GET /audit_logs
Example request
shell
curl \
-H "Authorization: Bearer YOUR-API-KEY" \
"https://api.vidbeo.com/v2/audit_logs"
Example response
json
{
"success": true,
"result": [
{
"id": "ca6286a0-d873-4d3e-a150-32478fe1d8f2",
"actor_type": "user",
"actor_id": "abcde12345abcde12345a",
"entity_type": "videos",
"entity_id": "abcde12345abcde12345a",
"action_type": "create",
"action_data": "{\"name\":\"Test video\"}",
"action_ip": "",
"action_time": "2022-01-01T00:00:00.000Z"
},
...
],
"links": {},
"errors": []
}
Optional parameters
| Name | Type | Default | Information |
|---|---|---|---|
| limit | String | 25 | Maximum number to return |
| cursor | String | "" | Used to get the next page of results: if applicable we return this as part of the links.next URL |
Response format
| Key | Type | Description |
|---|---|---|
| id | String | The unique identifier given to this entry |
| actor_type | String | Either "user" (the action was done during a dashboard session) or "application" (the action was done using an external API key) |
| actor_id | String | The ID of the user/key that did the action |
| entity_type | String | The type of resource the action was done to. For example "videos" |
| entity_id | String | The ID of the resource the action was done to or resulted in |
| action_type | String | The type of action. We log modifications so this will be "create", "update" or "delete" |
| action_data | String | Some actions, like creating a video, need a JSON body to be sent: this is that incoming data |
| action_ip | String | The IP this action was done from, if known |
| action_time | String | The date and time the action was done |