Skip to content
On this page

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

NameTypeDefaultInformation
limitString25Maximum number to return
cursorString""Used to get the next page of results: if applicable we return this as part of the links.next URL

Response format

KeyTypeDescription
idStringThe unique identifier given to this entry
actor_typeStringEither "user" (the action was done during a dashboard session) or "application" (the action was done using an external API key)
actor_idStringThe ID of the user/key that did the action
entity_typeStringThe type of resource the action was done to. For example "videos"
entity_idStringThe ID of the resource the action was done to or resulted in
action_typeStringThe type of action. We log modifications so this will be "create", "update" or "delete"
action_dataStringSome actions, like creating a video, need a JSON body to be sent: this is that incoming data
action_ipStringThe IP this action was done from, if known
action_timeStringThe date and time the action was done