Audit Log

Retrieve audit events filtered by search criteria

GET

https://partner-api.monta.com

/api/v1/auditlog/events

Required scope: audit-log:read

Retrieve audit events filtered by search criteria › query Parameters

operatorId

integer | null · int64

Limit results to a certain operator

Example: 1

userId

string | null

Limit results to events caused by the user with this id. Supports comma-separated values for multiple IDs (e.g. '85,1').

Example: 1

teamId

integer | null · int64

Limit results to events caused in the context of the team with this id

Example: 1

entityType

string | null

Only return events caused on this type of entity. Supports comma-separated values for multiple types (e.g. 'Team,ChargePoint').

Example: Team

entityId

string | null

Only return events on the entity with this ID (use in conjunction with entityType)

Example: 1

action

string | null

Only return events that logged this action. Supports comma-separated values for multiple actions (e.g. 'CREATE,UPDATE').

Example: UPDATE

operation

string | null

Only return events that logged this operation. Supports comma-separated values for multiple operations (e.g. 'REBOOT,UNLOCK').

Example: REBOOT

sourceType

string | null

Only return events initiated by this kind of actor. Supports comma-separated values for multiple types (e.g. 'USER,SYSTEM').

Example: SYSTEM

search

string | null

Free-text search in matching events

Example: update team SomeUserName

toDate

string | null · date-time

Only return events before this point in time (ISO 8601 format)

Example: 2024-05-22T09:30:03Z

fromDate

string | null · date-time

Only return events after this point in time (ISO 8601 format)

Example: 2024-05-22T09:50:03Z

perPage

integer | null · int32 · min: 1 · max: 10000

The maximum number of results to return

Example: 20

Default: 50

after

string | null

Cursor (event id) to retrieve results ordered after a certain event. Use this with a cursor from meta.after to retrieve the next page of results.

Example: MTcwNjYyMTcwMDEyM3xfTVF0eG8wQjVXRnNEN194ZC1uaw==

before

string | null

Cursor (event id) to retrieve results ordered before a certain event. Use this with a cursor from meta.before to retrieve the previous page of results. This parameter is ignored if afteris provided in the request as well.

Example: MTcwNjYyMTcwMDEyM3xfTVF0eG8wQjVXRnNEN194ZC1uaw==

Retrieve audit events filtered by search criteria › Responses

List of events that match the criteria

CursorBasedResponse_1

AuditEvent[] · required

CursorBasedPageMeta · required

Retrieve single audit event by id

GET

https://partner-api.monta.com

/api/v1/auditlog/events/{eventId}

Required scope: audit-log:read

Retrieve single audit event by id › path Parameters

eventId

string · required

The id of the event to retrieve

Retrieve single audit event by id › Responses

The requested event

An event describing a single action taken within the system by a user

AuditEvent

id

string · required

A unique identifier used for single retrieval and paging

Example: MTcwNjYyMTcwMDEyM3xfTVF0eG8wQjVXRnNEN194ZC1uaw==

timestamp

string · date-time · required

The time (UTC) the action was taken

Example: 2024-02-22T18:01:26.242Z

operatorId

integer · int64 · required

The operator under which the action was taken

Example: 1

object · required

User details (at the time of the event) of the user that performed the action

action

string · required

The action (verb) that was performed, like CREATE, UPDATE, DELETE, TRIGGER

Example: UPDATE

entityId

string · required

The ID of the entity (subject) that the event applies to

Example: 1

entityType

string · required

The type of the entity (subject) that the event applies to, like Operator, Team, OperatorUser, TeamMember

Example: Team

object · required

Additional data + context for the action taken

teamId

integer | null · int64

The team under which the action was taken, if any

Example: 1

operation

string | null

The specific command that was issued, for actions that carry one (like TRIGGER). Values are open-ended, like REBOOT, UNLOCK, SYNC, FIRMWARE_UPDATE.

Example: REBOOT

object

What initiated the action, if known

Alerts Authentication