Get Audit Logs

GET /api/dashboard/audit-log

This endpoint retrieves a list of admin audit logs ordered by most recent.

Query Parameters

userName Optional

<first-name>:<last-name> of the admin to filter logs by.

startsAt Optional

Unix Epoch format (millis). This is the timestamp where the results will start and continue in the past (most recent).
Default is the current time.

endsAt Optional

Unix Epoch format (millis). This is the timestamp where the results will end and not go any further into the past (oldest).

limit Optional

Max item count in response.
Default is 30.

Security

This endpoint requires authentication. You must include a valid API key in the request header. Permission(s) Required: VIEW_AUDIT_LOGS

Response Body

{
    "last_date": timestamp,
    "data": AuditLogEntry[]
}

last_date

Unix Epoch format (millis). This is the timestmap of the last log entry in the response.
Use this to get the next page of logs by passing it as a query parameter to the next request.

data

Log entry data.

[
    {
        "first_name": string,
        "last_name": string,
        "timestamp": timestamp,
        "action": ActionType,
        "site_id": string | null,
        "data": Object | null,
    },
    {...}
]

first_name

First name of the admin user.

last_name

Last name of the admin user.

timestamp

Unix Epoch format (millis). This is the time when the log entry was created.

action

Type of audit log event.

EDIT_PROJECTS - Admin edited kiosk projects. siteId
EDIT_ANNOUNCEMENTS - Admin edited announcements. siteId
EDIT_FEATURED - Admin edited featured items. siteId
LOG_IN - Admin logged into the dashboard.
LOG_OUT - Admin logged out of their dashboard.
LOAD_DASHBOARD - Admin visited the dashboard.

EXPORT_DATA - Admin exported data.

{
    "type": "LOG" | "MEMBERS",
    "days": number | "ALL_TIME"
}

APP_APPROVE - Admin approved an appointment.

{
    "creatorFirstName": string,
    "creatorLastName": string,
    "id": string
}

APP_CANCEL - Admin cancelled an appointment.

{
    "creatorFirstName": string,
    "creatorLastName": string,
    "id": string
}

DEVICE_ADD - Admin setup a new ChromeOS kiosk or display device.

{
    "type": "KIOSK" | "DISPLAY",
    "prettyName": string
}

DEVICE_EDIT - Admin modified the settings of a ChromeOS kiosk or display device.

site_id Nullable

ID of the subsite related to this event.
This will be null if the event type is not related to a subsite. See action for which event types have a siteId.

data Nullable

Additionaly data relevant to this event.
This will be null if the event type has no data. See action for which event types have a data.