Working with Audit Logs

Overview

Frame.io supports and maintains Audit Logs for the vast majority of activities taken in its applications. This includes both basic CRUD on core resources, and some special abstractions (e.g. AssetVersioned).

Scope and permissions

Only Account Admins may access the Audit Logs for an Account, and all calls to the Audit Logs endpoint must be scoped to an account_id as follows:

GET https://api.frame.io/v2/accounts/:id/audit_logs

Responses

Audit Log responses all have a similar format:

1
{
2
    "_type": "audit",
3
    "account_id": "<account-id>",
4
    "action": "<ActionTaken>",
5
    "actor": {
6
        "_type": "user",
7
        "id": "<user-id>",
8
    },
9
    "actor_id": "<user-id>",
10
    "id": "<audit-id>",
11
    "inserted_at": "<ISO-8601-datetime>",
12
    "item_id": "<resource-id>",
13
    "item_type": "<ResourceType>",
14
    "resource": {...},
15
    "team_id": "<team-id>",
16
    "updated_at": "<ISO-8601-datetime>"
17
}

Filters

Audit Logs support a variety of filters, including date ranges. Unlike Frame.io’s Search endpoints, filters can be sent only as GET query string params.

Filters all follow the same formatting:

GET + query string

1
GET
2
https://api.frame.io/accounts/:id/audit_logs?filter[filter_type1]=value1&filter[filter_type2]=value2

Key filter types

The key filter types for culling and navigating Audit Logs are:

Item Types and Actions

Filter examples

Filters all follow a similar format, as outlined above. Below are a handful of examples target at specific use cases that can help you get started.

Date ranges

Date ranges are a slightly special case, in that it’s necessary to specify both the inserted_at datetime value, and the operation to apply to that datetime.

Accordingly, date range queries will always have two filter elements, each of which will itself be nested beside an [inserted_at] parameter.

Supported operations include:

• gt: greater than
• gte: greater than or equal to
• lt: less than
• lte: less than or equal to

Date range examples