Order Management System REST API - Event Audit Controller
The event/audit/fromdate
URL provides access to the events generated by OMS views.
Retrieve events between two timestamps
Section titled “Retrieve events between two timestamps”GET /event/audit/fromdate
Retrieves the events between two timestamps in the event stream.
Requires the Audit
feature permission.
Query Parameters
Section titled “Query Parameters”Parameter | Expected | Description |
---|---|---|
from | Optional | An ISO8601 date and time. The earliest timestamp to return (exclusive). If omitted, defaults to the beginning of time. |
to | Optional | An ISO8601 date and time. The most recent timestamp to return (inclusive). If omitted, defaults to now. |
count | Optional | An integer. The maximum number of records to return. If omitted, returns every record. |
for | Optional | The SubscriptionType to return events for. Repeat for additional views. If omitted, supplies events for all views. |
snapshot | Optional | True to include starting snapshot events for the requested views. If omitted or false, no snapshot is supplied. |
Response
Section titled “Response”Code | Status | Description |
---|---|---|
200 | Success | Content is an array of EventMessage objects. |
403 | Failure | You supplied invalid owner or account values. |
Examples
Section titled “Examples”In this example, we retrieve the first 100 Transaction events in the six-month period.
curl --oauth2-bearer $AccessToken http://oms.hub/event/audit/fromdate?from=20250101T000000Z&to=20250601T000000Z&count=100&for=Transactions