IRPCEventsAdmin.GetEventsRange

Administration API / specialized admin session idempotent

Gets events by ID range and filters, oldest or newest first, with an optional maximum count.

Service	Event administration `MFiles.IRPCEventsAdmin`
gRPC method	`/MFiles.IRPCEventsAdmin/GetEventsRange`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-events-range`
Request	`GetEventsRangeRequest`
Response	`GetEventsRangeResponse`
Book and level	Administration API, specialized
Kind	admin
Session	Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotent	yes
Returns metadata structure version	no
Streaming	none (unary)

Remarks

Requires a vault session, the vault right manage_events, and client_data.version set at login (see the service overview).
Set -1 explicitly in oldest_event_to_get, newest_event_to_get, object_type_filter and object_id_filter unless you filter on them; 0 is a real value, so a default request returns nothing.
Filters are combined with AND. object_title_filter and event_caused_by_user must match exactly (event_caused_by_user is the account name, as in Event.caused_by_user). The time filter applies only when both start_time_filter and end_time_filter are set.
Events are sorted by ID: ascending, or descending with get_newest. To page, repeat the call with oldest_event_to_get (or newest_event_to_get with get_newest) moved past the last ID you received. Internal notification-matching events are never returned.
Fails with "Your event log request exceeds the maximum data size." when the matching events hold more data than the vault allows in one request (512 MiB by default); narrow the range.
Event.notification_object_info is filled only in vaults with the advanced event log features.

Request: GetEventsRangeRequest

Gets the specified range of events from the vault.

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

Field	Type	Description
`oldest_event_to_get`	`int64`	The lowest event ID to return, or -1 for no lower bound.
`newest_event_to_get`	`int64`	The highest event ID to return, or -1 for no upper bound. The default 0 returns nothing.
`max_events_to_return`	`uint32`	The maximum number of events to return; 0 for no limit. With `get_newest` the newest matching events are returned, otherwise the oldest.
`get_newest`	`bool`	True to return the newest matching events first (descending IDs), false for the oldest first.
`object_type_filter`	`int32`	Only events of objects of this object type, or -1 for all.
`object_id_filter`	`int32`	Only events of the object with this ID, or -1 for all.
`object_title_filter`	`string`	Only events of objects with exactly this title; empty for all.
`object_class_filter`	`int32`	Only events of objects of this class; used only when `has_class_filter` is true.
`has_class_filter`	`bool`	True to apply `object_class_filter`.
`start_time_filter`	`google.protobuf.Timestamp`	Only events at or after this time (UTC). Used only together with `end_time_filter`.
`end_time_filter`	`google.protobuf.Timestamp`	Only events at or before this time (UTC). Used only together with `start_time_filter`.
`event_types`	`EventTypeArray`	Only events of these types; empty for all types.
`event_types.event_types[]`	repeated `EventType`	The event types.
`event_caused_by_user`	`string`	Only events caused by this account name; empty for all.

Response: GetEventsRangeResponse