# Event service An Event is an annotated moment or time range. The Event Service is responsible for creating and retrieving events for a particular data source. OpenAPI file: [`nominal.event.v2.json`](https://dev.nominal.io/api/_downloads/d860877c33fe43b1dca94daf47099b0a/nominal.event.v2.json) ## Endpoints ### Create event POST `/event/v2/events` Creates an event. Body `assetRids` array of string : Must contain at least one asset rid. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : If empty, defaults to a single API origin. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : If not provided, defaults to an empty string. `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` required : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Response `event` [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : ​ Fields of `Event` `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events", headers={"Authorization": "Bearer "}, json={ "assetRids": [""], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": {"": ""}, }, }, ], }, }, ], "timestamp": {"seconds": "1", "nanos": "1"}, "duration": {"seconds": "1", "nanos": "1"}, "name": "", "description": "", "type": "INFO", "labels": [""], "properties": {"": ""}, "disposition": { "priority": "P0", "state": {"pendingReview": {"openedBy": ""}}, "assignees": [""], }, "typedProperties": {"": {"stringValue": ""}}, }, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events", headers={"Authorization": "Bearer "}, json={ "assetRids": [""], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": {"": ""}, }, }, ], }, }, ], "timestamp": {"seconds": "1", "nanos": "1"}, "duration": {"seconds": "1", "nanos": "1"}, "name": "", "description": "", "type": "INFO", "labels": [""], "properties": {"": ""}, "disposition": { "priority": "P0", "state": {"pendingReview": {"openedBy": ""}}, "assignees": [""], }, "typedProperties": {"": {"stringValue": ""}}, }, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events", headers={"Authorization": "Bearer "}, json={ "assetRids": [""], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": {"": ""}, }, }, ], }, }, ], "timestamp": {"seconds": "1", "nanos": "1"}, "duration": {"seconds": "1", "nanos": "1"}, "name": "", "description": "", "type": "INFO", "labels": [""], "properties": {"": ""}, "disposition": { "priority": "P0", "state": {"pendingReview": {"openedBy": ""}}, "assignees": [""], }, "typedProperties": {"": {"stringValue": ""}}, }, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "event": { "uuid": "", "rid": "", "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "isArchived": true, "createdBy": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } } } ``` ### Aggregate events POST `/event/v2/events/aggregate` Searches for events matching the given filter and aggregates them based on the requested functions. Body `query` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ Fields of `SearchQuery` one of 41 fields : ​ **archived** `archived` boolean : ​ **searchText** `searchText` string : Search text to perform fuzzy searching against. **exactMatch** `exactMatch` string : Search text to perform exact matching against on the event name and description. **after** `after` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events after this timestamp, exclusive. Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ **before** `before` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events before this timestamp, exclusive. **advancedTimeFilter** `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/rest/event-service.md#eventtimefilter) : ​ Fields of `EventTimeFilter` `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/rest/event-service.md#eventtimefiltercondition) : ​ Values of `EventTimeFilterCondition` `EVENT_TIME_FILTER_CONDITION_UNSPECIFIED` : ​ `START_TIME_BEFORE_INCLUSIVE` : ​ `START_TIME_BEFORE_EXCLUSIVE` : ​ `START_TIME_AFTER_INCLUSIVE` : ​ `START_TIME_AFTER_EXCLUSIVE` : ​ `END_TIME_BEFORE_INCLUSIVE` : ​ `END_TIME_BEFORE_EXCLUSIVE` : ​ `END_TIME_AFTER_INCLUSIVE` : ​ `END_TIME_AFTER_EXCLUSIVE` : ​ **asset** `asset` string : ​ **assets** `assets` [`AssetsFilter`](https://dev.nominal.io/api/rest/event-service.md#assetsfilter) : ​ Fields of `AssetsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ Values of `SetOperator` `SET_OPERATOR_UNSPECIFIED` : ​ `AND` : ​ `OR` : ​ `assets` array of string : ​ **template** `template` string : ​ **workbook** `workbook` string : ​ **dataReview** `dataReview` string : ​ **dataReviews** `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewsfilter) : ​ Fields of `DataReviewsFilter` `dataReviews` array of string : ​ **originType** `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ Values of `SearchEventOriginType` `SEARCH_EVENT_ORIGIN_TYPE_UNSPECIFIED` : ​ `WORKBOOK` : ​ `TEMPLATE` : ​ `API` : ​ `DATA_REVIEW` : ​ `PROCEDURE` : ​ `STREAMING_CHECKLIST` : ​ **originTypes** `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/rest/event-service.md#origintypesfilter) : ​ Fields of `OriginTypesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ **dataReviewCheck** `dataReviewCheck` string : ​ **dataReviewChecks** `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewchecksfilter) : ​ Fields of `DataReviewChecksFilter` `dataReviewChecks` array of string : ​ **dispositionStatus** `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ Values of `EventDispositionStatus` `EVENT_DISPOSITION_STATUS_UNSPECIFIED` : ​ `PENDING_REVIEW` : ​ `CLOSED_IGNORED` : ​ `CLOSED_REQUIRES_FURTHER_ACTION` : ​ `NO_DISPOSITION` : ​ **dispositionStatuses** `dispositionStatuses` [`EventDispositionStatusList`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatuslist) : ​ Fields of `EventDispositionStatusList` `values` array of [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ **priority** `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ **priorities** `priorities` [`PriorityList`](https://dev.nominal.io/api/rest/event-service.md#prioritylist) : ​ Fields of `PriorityList` `values` array of [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ **assignee** `assignee` string : ​ **assignees** `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/rest/event-service.md#assigneesfilter) : ​ Fields of `AssigneesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `assignees` array of string : ​ **eventType** `eventType` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ **eventTypes** `eventTypes` [`EventTypeList`](https://dev.nominal.io/api/rest/event-service.md#eventtypelist) : ​ Fields of `EventTypeList` `values` array of [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ **createdBy** `createdBy` string : ​ **createdByAnyOf** `createdByAnyOf` [`UserRidList`](https://dev.nominal.io/api/rest/event-service.md#userridlist) : ​ Fields of `UserRidList` `values` array of string : ​ **label** `label` string : ​ **labels** `labels` [`LabelsFilter`](https://dev.nominal.io/api/rest/event-service.md#labelsfilter) : ​ Fields of `LabelsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `labels` array of string : ​ **property** `property` [`Property`](https://dev.nominal.io/api/rest/event-service.md#property) : ​ Fields of `Property` `name` string : ​ `value` string : ​ **properties** `properties` [`PropertiesFilter`](https://dev.nominal.io/api/rest/event-service.md#propertiesfilter) : ​ Fields of `PropertiesFilter` `name` string : ​ `values` array of string : ​ **and** `and` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ Fields of `SearchQueryList` `queries` array of [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **or** `or` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ **not** `not` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **workspace** `workspace` string : ​ **procedure** `procedure` string : ​ **procedureExecution** `procedureExecution` string : ​ **stepId** `stepId` string : ​ **streamingChecklist** `streamingChecklist` string : Filters to events created from a checklist executing in streaming. **streamingCheck** `streamingCheck` string : Filters to events created from the check of a checklist executing in streaming. **numericProperty** `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertypredicate) : Matches events using a numeric property comparison. Fields of `NumericPropertyPredicate` `name` string : ​ `value` number : ​ `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/rest/event-service.md#propertycomparisonoperator) : ​ Values of `PropertyComparisonOperator` `PROPERTY_COMPARISON_OPERATOR_UNSPECIFIED` : ​ `EQ` : ​ `NEQ` : ​ `GT` : ​ `GTE` : ​ `LT` : ​ `LTE` : ​ **numericPropertyRange** `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangepredicate) : Matches events using an inclusive numeric property range. Fields of `NumericPropertyRangePredicate` `name` string : ​ `min` number : ​ `max` number : ​ `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangeoperator) : ​ Values of `NumericPropertyRangeOperator` `NUMERIC_PROPERTY_RANGE_OPERATOR_UNSPECIFIED` : ​ `BETWEEN` : ​ `NOT_BETWEEN` : ​ `aggregateTypes` array of [`AggregateType`](https://dev.nominal.io/api/rest/event-service.md#aggregatetype) : ​ Values of `AggregateType` `AGGREGATE_TYPE_UNSPECIFIED` : ​ `TOTAL_DURATION` : ​ `TOTAL_COUNT` : ​ Response `values` map of string to [`AggregateValue`](https://dev.nominal.io/api/rest/event-service.md#aggregatevalue) : Keyed by AggregateType enum value name (proto3 forbids enum map keys). Fields of `AggregateValue` one of `duration`, `count` : ​ **duration** `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ **count** `count` integer : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/aggregate" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "query": { "archived": true }, "aggregateTypes": [ "TOTAL_DURATION" ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/aggregate", headers={"Authorization": "Bearer "}, json={"query": {"archived": True}, "aggregateTypes": ["TOTAL_DURATION"]}, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/aggregate", headers={"Authorization": "Bearer "}, json={"query": {"archived": True}, "aggregateTypes": ["TOTAL_DURATION"]}, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/aggregate", headers={"Authorization": "Bearer "}, json={"query": {"archived": True}, "aggregateTypes": ["TOTAL_DURATION"]}, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "values": { "": { "duration": { "seconds": "1", "nanos": "1" } } } } ``` ### Archive event POST `/event/v2/events/archive` Archives an event. Body `uuid` string : ​ Response An empty JSON object, `{}`. Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/archive" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "uuid": "" }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/archive", headers={"Authorization": "Bearer "}, json={"uuid": ""}, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/archive", headers={"Authorization": "Bearer "}, json={"uuid": ""}, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/archive", headers={"Authorization": "Bearer "}, json={"uuid": ""}, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json {} ``` ### Batch aggregate events POST `/event/v2/events/batch-aggregate` Aggregates each batched request and returns responses in the same order. Body `requests` array of [`AggregateEventsRequest`](https://dev.nominal.io/api/rest/event-service.md#aggregateeventsrequest) : ​ Fields of `AggregateEventsRequest` `query` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ Fields of `SearchQuery` one of 41 fields : ​ **archived** `archived` boolean : ​ **searchText** `searchText` string : Search text to perform fuzzy searching against. **exactMatch** `exactMatch` string : Search text to perform exact matching against on the event name and description. **after** `after` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events after this timestamp, exclusive. Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ **before** `before` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events before this timestamp, exclusive. **advancedTimeFilter** `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/rest/event-service.md#eventtimefilter) : ​ Fields of `EventTimeFilter` `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/rest/event-service.md#eventtimefiltercondition) : ​ Values of `EventTimeFilterCondition` `EVENT_TIME_FILTER_CONDITION_UNSPECIFIED` : ​ `START_TIME_BEFORE_INCLUSIVE` : ​ `START_TIME_BEFORE_EXCLUSIVE` : ​ `START_TIME_AFTER_INCLUSIVE` : ​ `START_TIME_AFTER_EXCLUSIVE` : ​ `END_TIME_BEFORE_INCLUSIVE` : ​ `END_TIME_BEFORE_EXCLUSIVE` : ​ `END_TIME_AFTER_INCLUSIVE` : ​ `END_TIME_AFTER_EXCLUSIVE` : ​ **asset** `asset` string : ​ **assets** `assets` [`AssetsFilter`](https://dev.nominal.io/api/rest/event-service.md#assetsfilter) : ​ Fields of `AssetsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ Values of `SetOperator` `SET_OPERATOR_UNSPECIFIED` : ​ `AND` : ​ `OR` : ​ `assets` array of string : ​ **template** `template` string : ​ **workbook** `workbook` string : ​ **dataReview** `dataReview` string : ​ **dataReviews** `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewsfilter) : ​ Fields of `DataReviewsFilter` `dataReviews` array of string : ​ **originType** `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ Values of `SearchEventOriginType` `SEARCH_EVENT_ORIGIN_TYPE_UNSPECIFIED` : ​ `WORKBOOK` : ​ `TEMPLATE` : ​ `API` : ​ `DATA_REVIEW` : ​ `PROCEDURE` : ​ `STREAMING_CHECKLIST` : ​ **originTypes** `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/rest/event-service.md#origintypesfilter) : ​ Fields of `OriginTypesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ **dataReviewCheck** `dataReviewCheck` string : ​ **dataReviewChecks** `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewchecksfilter) : ​ Fields of `DataReviewChecksFilter` `dataReviewChecks` array of string : ​ **dispositionStatus** `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ Values of `EventDispositionStatus` `EVENT_DISPOSITION_STATUS_UNSPECIFIED` : ​ `PENDING_REVIEW` : ​ `CLOSED_IGNORED` : ​ `CLOSED_REQUIRES_FURTHER_ACTION` : ​ `NO_DISPOSITION` : ​ **dispositionStatuses** `dispositionStatuses` [`EventDispositionStatusList`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatuslist) : ​ Fields of `EventDispositionStatusList` `values` array of [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ **priority** `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ **priorities** `priorities` [`PriorityList`](https://dev.nominal.io/api/rest/event-service.md#prioritylist) : ​ Fields of `PriorityList` `values` array of [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ **assignee** `assignee` string : ​ **assignees** `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/rest/event-service.md#assigneesfilter) : ​ Fields of `AssigneesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `assignees` array of string : ​ **eventType** `eventType` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ **eventTypes** `eventTypes` [`EventTypeList`](https://dev.nominal.io/api/rest/event-service.md#eventtypelist) : ​ Fields of `EventTypeList` `values` array of [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ **createdBy** `createdBy` string : ​ **createdByAnyOf** `createdByAnyOf` [`UserRidList`](https://dev.nominal.io/api/rest/event-service.md#userridlist) : ​ Fields of `UserRidList` `values` array of string : ​ **label** `label` string : ​ **labels** `labels` [`LabelsFilter`](https://dev.nominal.io/api/rest/event-service.md#labelsfilter) : ​ Fields of `LabelsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `labels` array of string : ​ **property** `property` [`Property`](https://dev.nominal.io/api/rest/event-service.md#property) : ​ Fields of `Property` `name` string : ​ `value` string : ​ **properties** `properties` [`PropertiesFilter`](https://dev.nominal.io/api/rest/event-service.md#propertiesfilter) : ​ Fields of `PropertiesFilter` `name` string : ​ `values` array of string : ​ **and** `and` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ Fields of `SearchQueryList` `queries` array of [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **or** `or` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ **not** `not` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **workspace** `workspace` string : ​ **procedure** `procedure` string : ​ **procedureExecution** `procedureExecution` string : ​ **stepId** `stepId` string : ​ **streamingChecklist** `streamingChecklist` string : Filters to events created from a checklist executing in streaming. **streamingCheck** `streamingCheck` string : Filters to events created from the check of a checklist executing in streaming. **numericProperty** `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertypredicate) : Matches events using a numeric property comparison. Fields of `NumericPropertyPredicate` `name` string : ​ `value` number : ​ `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/rest/event-service.md#propertycomparisonoperator) : ​ Values of `PropertyComparisonOperator` `PROPERTY_COMPARISON_OPERATOR_UNSPECIFIED` : ​ `EQ` : ​ `NEQ` : ​ `GT` : ​ `GTE` : ​ `LT` : ​ `LTE` : ​ **numericPropertyRange** `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangepredicate) : Matches events using an inclusive numeric property range. Fields of `NumericPropertyRangePredicate` `name` string : ​ `min` number : ​ `max` number : ​ `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangeoperator) : ​ Values of `NumericPropertyRangeOperator` `NUMERIC_PROPERTY_RANGE_OPERATOR_UNSPECIFIED` : ​ `BETWEEN` : ​ `NOT_BETWEEN` : ​ `aggregateTypes` array of [`AggregateType`](https://dev.nominal.io/api/rest/event-service.md#aggregatetype) : ​ Values of `AggregateType` `AGGREGATE_TYPE_UNSPECIFIED` : ​ `TOTAL_DURATION` : ​ `TOTAL_COUNT` : ​ Response `responses` array of [`AggregateEventsResponse`](https://dev.nominal.io/api/rest/event-service.md#aggregateeventsresponse) : ​ Fields of `AggregateEventsResponse` `values` map of string to [`AggregateValue`](https://dev.nominal.io/api/rest/event-service.md#aggregatevalue) : Keyed by AggregateType enum value name (proto3 forbids enum map keys). Fields of `AggregateValue` one of `duration`, `count` : ​ **duration** `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ **count** `count` integer : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-aggregate" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "requests": [ { "query": { "archived": true }, "aggregateTypes": [ "TOTAL_DURATION" ] } ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/batch-aggregate", headers={"Authorization": "Bearer "}, json={ "requests": [ {"query": {"archived": True}, "aggregateTypes": ["TOTAL_DURATION"]}, ], }, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/batch-aggregate", headers={"Authorization": "Bearer "}, json={ "requests": [ {"query": {"archived": True}, "aggregateTypes": ["TOTAL_DURATION"]}, ], }, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/batch-aggregate", headers={"Authorization": "Bearer "}, json={ "requests": [ {"query": {"archived": True}, "aggregateTypes": ["TOTAL_DURATION"]}, ], }, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "responses": [ { "values": { "": { "duration": { "seconds": "1", "nanos": "1" } } } } ] } ``` ### Batch archive event POST `/event/v2/events/batch-archive` Archives a set of events. Body `eventRids` array of string : ​ Response An empty JSON object, `{}`. Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-archive" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "eventRids": [ "" ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/batch-archive", headers={"Authorization": "Bearer "}, json={"eventRids": [""]}, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/batch-archive", headers={"Authorization": "Bearer "}, json={"eventRids": [""]}, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/batch-archive", headers={"Authorization": "Bearer "}, json={"eventRids": [""]}, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json {} ``` ### Batch filter events POST `/event/v2/events/batch-filter-get` Gets a filtered set of events by RID and search filters. Body `eventRids` array of string : ​ `filterQuery` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ Fields of `SearchQuery` one of 41 fields : ​ **archived** `archived` boolean : ​ **searchText** `searchText` string : Search text to perform fuzzy searching against. **exactMatch** `exactMatch` string : Search text to perform exact matching against on the event name and description. **after** `after` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events after this timestamp, exclusive. Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ **before** `before` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events before this timestamp, exclusive. **advancedTimeFilter** `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/rest/event-service.md#eventtimefilter) : ​ Fields of `EventTimeFilter` `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/rest/event-service.md#eventtimefiltercondition) : ​ Values of `EventTimeFilterCondition` `EVENT_TIME_FILTER_CONDITION_UNSPECIFIED` : ​ `START_TIME_BEFORE_INCLUSIVE` : ​ `START_TIME_BEFORE_EXCLUSIVE` : ​ `START_TIME_AFTER_INCLUSIVE` : ​ `START_TIME_AFTER_EXCLUSIVE` : ​ `END_TIME_BEFORE_INCLUSIVE` : ​ `END_TIME_BEFORE_EXCLUSIVE` : ​ `END_TIME_AFTER_INCLUSIVE` : ​ `END_TIME_AFTER_EXCLUSIVE` : ​ **asset** `asset` string : ​ **assets** `assets` [`AssetsFilter`](https://dev.nominal.io/api/rest/event-service.md#assetsfilter) : ​ Fields of `AssetsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ Values of `SetOperator` `SET_OPERATOR_UNSPECIFIED` : ​ `AND` : ​ `OR` : ​ `assets` array of string : ​ **template** `template` string : ​ **workbook** `workbook` string : ​ **dataReview** `dataReview` string : ​ **dataReviews** `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewsfilter) : ​ Fields of `DataReviewsFilter` `dataReviews` array of string : ​ **originType** `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ Values of `SearchEventOriginType` `SEARCH_EVENT_ORIGIN_TYPE_UNSPECIFIED` : ​ `WORKBOOK` : ​ `TEMPLATE` : ​ `API` : ​ `DATA_REVIEW` : ​ `PROCEDURE` : ​ `STREAMING_CHECKLIST` : ​ **originTypes** `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/rest/event-service.md#origintypesfilter) : ​ Fields of `OriginTypesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ **dataReviewCheck** `dataReviewCheck` string : ​ **dataReviewChecks** `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewchecksfilter) : ​ Fields of `DataReviewChecksFilter` `dataReviewChecks` array of string : ​ **dispositionStatus** `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ Values of `EventDispositionStatus` `EVENT_DISPOSITION_STATUS_UNSPECIFIED` : ​ `PENDING_REVIEW` : ​ `CLOSED_IGNORED` : ​ `CLOSED_REQUIRES_FURTHER_ACTION` : ​ `NO_DISPOSITION` : ​ **dispositionStatuses** `dispositionStatuses` [`EventDispositionStatusList`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatuslist) : ​ Fields of `EventDispositionStatusList` `values` array of [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ **priority** `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ **priorities** `priorities` [`PriorityList`](https://dev.nominal.io/api/rest/event-service.md#prioritylist) : ​ Fields of `PriorityList` `values` array of [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ **assignee** `assignee` string : ​ **assignees** `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/rest/event-service.md#assigneesfilter) : ​ Fields of `AssigneesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `assignees` array of string : ​ **eventType** `eventType` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ **eventTypes** `eventTypes` [`EventTypeList`](https://dev.nominal.io/api/rest/event-service.md#eventtypelist) : ​ Fields of `EventTypeList` `values` array of [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ **createdBy** `createdBy` string : ​ **createdByAnyOf** `createdByAnyOf` [`UserRidList`](https://dev.nominal.io/api/rest/event-service.md#userridlist) : ​ Fields of `UserRidList` `values` array of string : ​ **label** `label` string : ​ **labels** `labels` [`LabelsFilter`](https://dev.nominal.io/api/rest/event-service.md#labelsfilter) : ​ Fields of `LabelsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `labels` array of string : ​ **property** `property` [`Property`](https://dev.nominal.io/api/rest/event-service.md#property) : ​ Fields of `Property` `name` string : ​ `value` string : ​ **properties** `properties` [`PropertiesFilter`](https://dev.nominal.io/api/rest/event-service.md#propertiesfilter) : ​ Fields of `PropertiesFilter` `name` string : ​ `values` array of string : ​ **and** `and` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ Fields of `SearchQueryList` `queries` array of [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **or** `or` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ **not** `not` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **workspace** `workspace` string : ​ **procedure** `procedure` string : ​ **procedureExecution** `procedureExecution` string : ​ **stepId** `stepId` string : ​ **streamingChecklist** `streamingChecklist` string : Filters to events created from a checklist executing in streaming. **streamingCheck** `streamingCheck` string : Filters to events created from the check of a checklist executing in streaming. **numericProperty** `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertypredicate) : Matches events using a numeric property comparison. Fields of `NumericPropertyPredicate` `name` string : ​ `value` number : ​ `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/rest/event-service.md#propertycomparisonoperator) : ​ Values of `PropertyComparisonOperator` `PROPERTY_COMPARISON_OPERATOR_UNSPECIFIED` : ​ `EQ` : ​ `NEQ` : ​ `GT` : ​ `GTE` : ​ `LT` : ​ `LTE` : ​ **numericPropertyRange** `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangepredicate) : Matches events using an inclusive numeric property range. Fields of `NumericPropertyRangePredicate` `name` string : ​ `min` number : ​ `max` number : ​ `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangeoperator) : ​ Values of `NumericPropertyRangeOperator` `NUMERIC_PROPERTY_RANGE_OPERATOR_UNSPECIFIED` : ​ `BETWEEN` : ​ `NOT_BETWEEN` : ​ Response `events` array of [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : ​ Fields of `Event` `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-filter-get" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "eventRids": [ "" ], "filterQuery": { "archived": true } }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/batch-filter-get", headers={"Authorization": "Bearer "}, json={"eventRids": [""], "filterQuery": {"archived": True}}, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/batch-filter-get", headers={"Authorization": "Bearer "}, json={"eventRids": [""], "filterQuery": {"archived": True}}, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/batch-filter-get", headers={"Authorization": "Bearer "}, json={"eventRids": [""], "filterQuery": {"archived": True}}, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "events": [ { "uuid": "", "rid": "", "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "isArchived": true, "createdBy": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } } ] } ``` ### Batch find events POST `/event/v2/events/batch-find` Finds, for each batched query, the single event at the query’s index among events matching the shared base query within the query’s asset and time-window constraints. Returns one result per query in the same order. Best-effort under permission filtering: each query fetches index + 1 candidate rows and then removes events the caller cannot view, so when hidden events fall inside those candidates a query may report no event even though a later visible match exists. Body `query` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : The base query every batched find matches against, combined with each query’s asset and window constraints. Fields of `SearchQuery` one of 41 fields : ​ **archived** `archived` boolean : ​ **searchText** `searchText` string : Search text to perform fuzzy searching against. **exactMatch** `exactMatch` string : Search text to perform exact matching against on the event name and description. **after** `after` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events after this timestamp, exclusive. Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ **before** `before` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events before this timestamp, exclusive. **advancedTimeFilter** `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/rest/event-service.md#eventtimefilter) : ​ Fields of `EventTimeFilter` `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/rest/event-service.md#eventtimefiltercondition) : ​ Values of `EventTimeFilterCondition` `EVENT_TIME_FILTER_CONDITION_UNSPECIFIED` : ​ `START_TIME_BEFORE_INCLUSIVE` : ​ `START_TIME_BEFORE_EXCLUSIVE` : ​ `START_TIME_AFTER_INCLUSIVE` : ​ `START_TIME_AFTER_EXCLUSIVE` : ​ `END_TIME_BEFORE_INCLUSIVE` : ​ `END_TIME_BEFORE_EXCLUSIVE` : ​ `END_TIME_AFTER_INCLUSIVE` : ​ `END_TIME_AFTER_EXCLUSIVE` : ​ **asset** `asset` string : ​ **assets** `assets` [`AssetsFilter`](https://dev.nominal.io/api/rest/event-service.md#assetsfilter) : ​ Fields of `AssetsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ Values of `SetOperator` `SET_OPERATOR_UNSPECIFIED` : ​ `AND` : ​ `OR` : ​ `assets` array of string : ​ **template** `template` string : ​ **workbook** `workbook` string : ​ **dataReview** `dataReview` string : ​ **dataReviews** `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewsfilter) : ​ Fields of `DataReviewsFilter` `dataReviews` array of string : ​ **originType** `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ Values of `SearchEventOriginType` `SEARCH_EVENT_ORIGIN_TYPE_UNSPECIFIED` : ​ `WORKBOOK` : ​ `TEMPLATE` : ​ `API` : ​ `DATA_REVIEW` : ​ `PROCEDURE` : ​ `STREAMING_CHECKLIST` : ​ **originTypes** `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/rest/event-service.md#origintypesfilter) : ​ Fields of `OriginTypesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ **dataReviewCheck** `dataReviewCheck` string : ​ **dataReviewChecks** `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewchecksfilter) : ​ Fields of `DataReviewChecksFilter` `dataReviewChecks` array of string : ​ **dispositionStatus** `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ Values of `EventDispositionStatus` `EVENT_DISPOSITION_STATUS_UNSPECIFIED` : ​ `PENDING_REVIEW` : ​ `CLOSED_IGNORED` : ​ `CLOSED_REQUIRES_FURTHER_ACTION` : ​ `NO_DISPOSITION` : ​ **dispositionStatuses** `dispositionStatuses` [`EventDispositionStatusList`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatuslist) : ​ Fields of `EventDispositionStatusList` `values` array of [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ **priority** `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ **priorities** `priorities` [`PriorityList`](https://dev.nominal.io/api/rest/event-service.md#prioritylist) : ​ Fields of `PriorityList` `values` array of [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ **assignee** `assignee` string : ​ **assignees** `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/rest/event-service.md#assigneesfilter) : ​ Fields of `AssigneesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `assignees` array of string : ​ **eventType** `eventType` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ **eventTypes** `eventTypes` [`EventTypeList`](https://dev.nominal.io/api/rest/event-service.md#eventtypelist) : ​ Fields of `EventTypeList` `values` array of [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ **createdBy** `createdBy` string : ​ **createdByAnyOf** `createdByAnyOf` [`UserRidList`](https://dev.nominal.io/api/rest/event-service.md#userridlist) : ​ Fields of `UserRidList` `values` array of string : ​ **label** `label` string : ​ **labels** `labels` [`LabelsFilter`](https://dev.nominal.io/api/rest/event-service.md#labelsfilter) : ​ Fields of `LabelsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `labels` array of string : ​ **property** `property` [`Property`](https://dev.nominal.io/api/rest/event-service.md#property) : ​ Fields of `Property` `name` string : ​ `value` string : ​ **properties** `properties` [`PropertiesFilter`](https://dev.nominal.io/api/rest/event-service.md#propertiesfilter) : ​ Fields of `PropertiesFilter` `name` string : ​ `values` array of string : ​ **and** `and` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ Fields of `SearchQueryList` `queries` array of [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **or** `or` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ **not** `not` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **workspace** `workspace` string : ​ **procedure** `procedure` string : ​ **procedureExecution** `procedureExecution` string : ​ **stepId** `stepId` string : ​ **streamingChecklist** `streamingChecklist` string : Filters to events created from a checklist executing in streaming. **streamingCheck** `streamingCheck` string : Filters to events created from the check of a checklist executing in streaming. **numericProperty** `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertypredicate) : Matches events using a numeric property comparison. Fields of `NumericPropertyPredicate` `name` string : ​ `value` number : ​ `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/rest/event-service.md#propertycomparisonoperator) : ​ Values of `PropertyComparisonOperator` `PROPERTY_COMPARISON_OPERATOR_UNSPECIFIED` : ​ `EQ` : ​ `NEQ` : ​ `GT` : ​ `GTE` : ​ `LT` : ​ `LTE` : ​ **numericPropertyRange** `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangepredicate) : Matches events using an inclusive numeric property range. Fields of `NumericPropertyRangePredicate` `name` string : ​ `min` number : ​ `max` number : ​ `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangeoperator) : ​ Values of `NumericPropertyRangeOperator` `NUMERIC_PROPERTY_RANGE_OPERATOR_UNSPECIFIED` : ​ `BETWEEN` : ​ `NOT_BETWEEN` : ​ `sort` [`SortOptions`](https://dev.nominal.io/api/rest/event-service.md#sortoptions) : ​ Fields of `SortOptions` `isDescending` boolean : ​ `field` [`SortField`](https://dev.nominal.io/api/rest/event-service.md#sortfield) : ​ Values of `SortField` `SORT_FIELD_UNSPECIFIED` : ​ `START_TIME` : ​ `END_TIME` : ​ `DURATION` : ​ `DISPOSITION_STATUS` : ​ `PRIORITY` : ​ `EVENT_NAME` : ​ `queries` array of [`FindEventsQuery`](https://dev.nominal.io/api/rest/event-service.md#findeventsquery) : Rejects batches with more than 1k queries. Fields of `FindEventsQuery` `assetRids` array of string : When non-empty, only events associated with at least one of these assets match. When empty, events match on the time window alone. `startInclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Half-open window [start_inclusive, end_exclusive) over event start times. An absent bound leaves that side of the window open. `endExclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `index` integer : Zero-based rank of the event to return after applying the request sort and permission filtering. Must be non-negative. When permission filtering hides events within the first index matches, the result may be absent even though later matches exist. Response `results` array of [`FindEventsResult`](https://dev.nominal.io/api/rest/event-service.md#findeventsresult) : One result per request query, in the same order. Fields of `FindEventsResult` `event` [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : Absent when no event matches the query at the requested index. Fields of `Event` `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-find" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "query": { "archived": true }, "sort": { "isDescending": true, "field": "START_TIME" }, "queries": [ { "assetRids": [ "" ], "startInclusive": { "seconds": "1", "nanos": "1" }, "endExclusive": { "seconds": "1", "nanos": "1" }, "index": 1 } ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/batch-find", headers={"Authorization": "Bearer "}, json={ "query": {"archived": True}, "sort": {"isDescending": True, "field": "START_TIME"}, "queries": [ { "assetRids": [""], "startInclusive": {"seconds": "1", "nanos": "1"}, "endExclusive": {"seconds": "1", "nanos": "1"}, "index": 1, }, ], }, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/batch-find", headers={"Authorization": "Bearer "}, json={ "query": {"archived": True}, "sort": {"isDescending": True, "field": "START_TIME"}, "queries": [ { "assetRids": [""], "startInclusive": {"seconds": "1", "nanos": "1"}, "endExclusive": {"seconds": "1", "nanos": "1"}, "index": 1, }, ], }, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/batch-find", headers={"Authorization": "Bearer "}, json={ "query": {"archived": True}, "sort": {"isDescending": True, "field": "START_TIME"}, "queries": [ { "assetRids": [""], "startInclusive": {"seconds": "1", "nanos": "1"}, "endExclusive": {"seconds": "1", "nanos": "1"}, "index": 1, }, ], }, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "results": [ { "event": { "uuid": "", "rid": "", "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "isArchived": true, "createdBy": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } } } ] } ``` ### Batch get events POST `/event/v2/events/batch-get` Gets a set of events by RID. Body `eventRids` array of string : ​ Response `events` array of [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : ​ Fields of `Event` `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-get" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "eventRids": [ "" ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/batch-get", headers={"Authorization": "Bearer "}, json={"eventRids": [""]}, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/batch-get", headers={"Authorization": "Bearer "}, json={"eventRids": [""]}, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/batch-get", headers={"Authorization": "Bearer "}, json={"eventRids": [""]}, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "events": [ { "uuid": "", "rid": "", "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "isArchived": true, "createdBy": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } } ] } ``` ### Batch unarchive event POST `/event/v2/events/batch-unarchive` Unarchives a set of events. Body `eventRids` array of string : ​ Response An empty JSON object, `{}`. Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-unarchive" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "eventRids": [ "" ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/batch-unarchive", headers={"Authorization": "Bearer "}, json={"eventRids": [""]}, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/batch-unarchive", headers={"Authorization": "Bearer "}, json={"eventRids": [""]}, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/batch-unarchive", headers={"Authorization": "Bearer "}, json={"eventRids": [""]}, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json {} ``` ### Batch update event POST `/event/v2/events/batch-update` Updates the fields of an event specified by each request in the batch. Empty fields are left unchanged. Body `updates` array of [`EventUpdate`](https://dev.nominal.io/api/rest/event-service.md#eventupdate) : ​ Fields of `EventUpdate` `rid` string : ​ `assetRids` [`AssetRidSet`](https://dev.nominal.io/api/rest/event-service.md#assetridset) : If provided, replaces the existing asset rids. If provided, must contain at least one asset rid. Fields of `AssetRidSet` `assetRids` array of string : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` [`LabelUpdateWrapper`](https://dev.nominal.io/api/rest/event-service.md#labelupdatewrapper) : ​ Fields of `LabelUpdateWrapper` `labels` array of string : ​ `properties` [`PropertyUpdateWrapper`](https://dev.nominal.io/api/rest/event-service.md#propertyupdatewrapper) deprecated : ​ Fields of `PropertyUpdateWrapper` `properties` map of string to string : ​ `typedProperties` [`TypedPropertyUpdateWrapper`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyupdatewrapper) : ​ Fields of `TypedPropertyUpdateWrapper` `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` required : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Response `events` array of [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : ​ Fields of `Event` `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-update" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "updates": [ { "rid": "", "assetRids": { "assetRids": [ "" ] }, "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": { "labels": [ "" ] }, "properties": { "properties": { "": "" } }, "typedProperties": { "typedProperties": { "": { "stringValue": "" } } } } ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/batch-update", headers={"Authorization": "Bearer "}, json={ "updates": [ { "rid": "", "assetRids": {"assetRids": [""]}, "timestamp": {"seconds": "1", "nanos": "1"}, "duration": {"seconds": "1", "nanos": "1"}, "name": "", "description": "", "type": "INFO", "labels": {"labels": [""]}, "properties": {"properties": {"": ""}}, "typedProperties": { "typedProperties": {"": {"stringValue": ""}}, }, }, ], }, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/batch-update", headers={"Authorization": "Bearer "}, json={ "updates": [ { "rid": "", "assetRids": {"assetRids": [""]}, "timestamp": {"seconds": "1", "nanos": "1"}, "duration": {"seconds": "1", "nanos": "1"}, "name": "", "description": "", "type": "INFO", "labels": {"labels": [""]}, "properties": {"properties": {"": ""}}, "typedProperties": { "typedProperties": {"": {"stringValue": ""}}, }, }, ], }, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/batch-update", headers={"Authorization": "Bearer "}, json={ "updates": [ { "rid": "", "assetRids": {"assetRids": [""]}, "timestamp": {"seconds": "1", "nanos": "1"}, "duration": {"seconds": "1", "nanos": "1"}, "name": "", "description": "", "type": "INFO", "labels": {"labels": [""]}, "properties": {"properties": {"": ""}}, "typedProperties": { "typedProperties": { "": {"stringValue": ""}, }, }, }, ], }, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "events": [ { "uuid": "", "rid": "", "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "isArchived": true, "createdBy": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } } ] } ``` ### Batch update disposition POST `/event/v2/events/batch-update-disposition` Updates the disposition of a set of events. Body `requests` array of [`UpdateDispositionRequest`](https://dev.nominal.io/api/rest/event-service.md#updatedispositionrequest) : ​ Fields of `UpdateDispositionRequest` `rid` string : ​ `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : The new disposition for the event. If empty, removes the disposition from the event. Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ Response `events` array of [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : ​ Fields of `Event` `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-update-disposition" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "requests": [ { "rid": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] } } ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/batch-update-disposition", headers={"Authorization": "Bearer "}, json={ "requests": [ { "rid": "", "disposition": { "priority": "P0", "state": {"pendingReview": {"openedBy": ""}}, "assignees": [""], }, }, ], }, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/batch-update-disposition", headers={"Authorization": "Bearer "}, json={ "requests": [ { "rid": "", "disposition": { "priority": "P0", "state": {"pendingReview": {"openedBy": ""}}, "assignees": [""], }, }, ], }, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/batch-update-disposition", headers={"Authorization": "Bearer "}, json={ "requests": [ { "rid": "", "disposition": { "priority": "P0", "state": {"pendingReview": {"openedBy": ""}}, "assignees": [""], }, }, ], }, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "events": [ { "uuid": "", "rid": "", "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "isArchived": true, "createdBy": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } } ] } ``` ### Get events POST `/event/v2/events/get-by-uuids` Gets a set of events by UUIDs. Body `uuids` array of string : ​ Response `events` array of [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : ​ Fields of `Event` `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/get-by-uuids" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "uuids": [ "" ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/get-by-uuids", headers={"Authorization": "Bearer "}, json={"uuids": [""]}, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/get-by-uuids", headers={"Authorization": "Bearer "}, json={"uuids": [""]}, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/get-by-uuids", headers={"Authorization": "Bearer "}, json={"uuids": [""]}, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "events": [ { "uuid": "", "rid": "", "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "isArchived": true, "createdBy": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } } ] } ``` ### Get events histogram POST `/event/v2/events/histogram` Gets a histogram of events that match the given filters. Body `startInclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `endExclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `filterQuery` [`HistogramFilterQuery`](https://dev.nominal.io/api/rest/event-service.md#histogramfilterquery) : The query to filter the events included in the histogram. Fields of `HistogramFilterQuery` one of 21 fields : ​ **searchText** `searchText` string : ​ **asset** `asset` string : ​ **template** `template` string : ​ **workbook** `workbook` string : ​ **dataReview** `dataReview` string : ​ **originType** `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ Values of `SearchEventOriginType` `SEARCH_EVENT_ORIGIN_TYPE_UNSPECIFIED` : ​ `WORKBOOK` : ​ `TEMPLATE` : ​ `API` : ​ `DATA_REVIEW` : ​ `PROCEDURE` : ​ `STREAMING_CHECKLIST` : ​ **dataReviewCheck** `dataReviewCheck` string : ​ **dispositionStatus** `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ Values of `EventDispositionStatus` `EVENT_DISPOSITION_STATUS_UNSPECIFIED` : ​ `PENDING_REVIEW` : ​ `CLOSED_IGNORED` : ​ `CLOSED_REQUIRES_FURTHER_ACTION` : ​ `NO_DISPOSITION` : ​ **priority** `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ **assignee** `assignee` string : ​ **eventType** `eventType` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ **createdBy** `createdBy` string : ​ **label** `label` string : ​ **property** `property` [`Property`](https://dev.nominal.io/api/rest/event-service.md#property) : ​ Fields of `Property` `name` string : ​ `value` string : ​ **and** `and` [`HistogramFilterQueryList`](https://dev.nominal.io/api/rest/event-service.md#histogramfilterquerylist) : ​ Fields of `HistogramFilterQueryList` `queries` array of [`HistogramFilterQuery`](https://dev.nominal.io/api/rest/event-service.md#histogramfilterquery) : ​ **or** `or` [`HistogramFilterQueryList`](https://dev.nominal.io/api/rest/event-service.md#histogramfilterquerylist) : ​ **not** `not` [`HistogramFilterQuery`](https://dev.nominal.io/api/rest/event-service.md#histogramfilterquery) : ​ **workspace** `workspace` string : ​ **procedure** `procedure` string : ​ **procedureExecution** `procedureExecution` string : ​ **stepId** `stepId` string : ​ `archivedStatuses` array of [`ArchivedStatus`](https://dev.nominal.io/api/rest/event-service.md#archivedstatus) : If empty, defaults to NOT_ARCHIVED only. Values of `ArchivedStatus` `ARCHIVED_STATUS_UNSPECIFIED` : ​ `NOT_ARCHIVED` : ​ `ARCHIVED` : ​ `numBins` integer : Defaults to 100. Throws if larger than 1_000. `eventLimit` integer : Limits the number of events included in the histogram. Defaults to 10_000. Throws if larger than 10_000. Response `buckets` array of [`EventsHistogramBucket`](https://dev.nominal.io/api/rest/event-service.md#eventshistogrambucket) : ​ Fields of `EventsHistogramBucket` `startInclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `endExclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `count` integer : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/histogram" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "startInclusive": { "seconds": "1", "nanos": "1" }, "endExclusive": { "seconds": "1", "nanos": "1" }, "filterQuery": { "searchText": "" }, "archivedStatuses": [ "NOT_ARCHIVED" ], "numBins": 1, "eventLimit": 1 }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/histogram", headers={"Authorization": "Bearer "}, json={ "startInclusive": {"seconds": "1", "nanos": "1"}, "endExclusive": {"seconds": "1", "nanos": "1"}, "filterQuery": {"searchText": ""}, "archivedStatuses": ["NOT_ARCHIVED"], "numBins": 1, "eventLimit": 1, }, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/histogram", headers={"Authorization": "Bearer "}, json={ "startInclusive": {"seconds": "1", "nanos": "1"}, "endExclusive": {"seconds": "1", "nanos": "1"}, "filterQuery": {"searchText": ""}, "archivedStatuses": ["NOT_ARCHIVED"], "numBins": 1, "eventLimit": 1, }, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/histogram", headers={"Authorization": "Bearer "}, json={ "startInclusive": {"seconds": "1", "nanos": "1"}, "endExclusive": {"seconds": "1", "nanos": "1"}, "filterQuery": {"searchText": ""}, "archivedStatuses": ["NOT_ARCHIVED"], "numBins": 1, "eventLimit": 1, }, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "buckets": [ { "startInclusive": { "seconds": "1", "nanos": "1" }, "endExclusive": { "seconds": "1", "nanos": "1" }, "count": 1 } ] } ``` ### Search events POST `/event/v2/events/search` Searches for events that match the given filters. Body `sort` [`SortOptions`](https://dev.nominal.io/api/rest/event-service.md#sortoptions) : ​ Fields of `SortOptions` `isDescending` boolean : ​ `field` [`SortField`](https://dev.nominal.io/api/rest/event-service.md#sortfield) : ​ Values of `SortField` `SORT_FIELD_UNSPECIFIED` : ​ `START_TIME` : ​ `END_TIME` : ​ `DURATION` : ​ `DISPOSITION_STATUS` : ​ `PRIORITY` : ​ `EVENT_NAME` : ​ `pageSize` integer : Rejects page sizes greater than 10k. `nextPageToken` string : ​ `query` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ Fields of `SearchQuery` one of 41 fields : ​ **archived** `archived` boolean : ​ **searchText** `searchText` string : Search text to perform fuzzy searching against. **exactMatch** `exactMatch` string : Search text to perform exact matching against on the event name and description. **after** `after` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events after this timestamp, exclusive. Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ **before** `before` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events before this timestamp, exclusive. **advancedTimeFilter** `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/rest/event-service.md#eventtimefilter) : ​ Fields of `EventTimeFilter` `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/rest/event-service.md#eventtimefiltercondition) : ​ Values of `EventTimeFilterCondition` `EVENT_TIME_FILTER_CONDITION_UNSPECIFIED` : ​ `START_TIME_BEFORE_INCLUSIVE` : ​ `START_TIME_BEFORE_EXCLUSIVE` : ​ `START_TIME_AFTER_INCLUSIVE` : ​ `START_TIME_AFTER_EXCLUSIVE` : ​ `END_TIME_BEFORE_INCLUSIVE` : ​ `END_TIME_BEFORE_EXCLUSIVE` : ​ `END_TIME_AFTER_INCLUSIVE` : ​ `END_TIME_AFTER_EXCLUSIVE` : ​ **asset** `asset` string : ​ **assets** `assets` [`AssetsFilter`](https://dev.nominal.io/api/rest/event-service.md#assetsfilter) : ​ Fields of `AssetsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ Values of `SetOperator` `SET_OPERATOR_UNSPECIFIED` : ​ `AND` : ​ `OR` : ​ `assets` array of string : ​ **template** `template` string : ​ **workbook** `workbook` string : ​ **dataReview** `dataReview` string : ​ **dataReviews** `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewsfilter) : ​ Fields of `DataReviewsFilter` `dataReviews` array of string : ​ **originType** `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ Values of `SearchEventOriginType` `SEARCH_EVENT_ORIGIN_TYPE_UNSPECIFIED` : ​ `WORKBOOK` : ​ `TEMPLATE` : ​ `API` : ​ `DATA_REVIEW` : ​ `PROCEDURE` : ​ `STREAMING_CHECKLIST` : ​ **originTypes** `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/rest/event-service.md#origintypesfilter) : ​ Fields of `OriginTypesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ **dataReviewCheck** `dataReviewCheck` string : ​ **dataReviewChecks** `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewchecksfilter) : ​ Fields of `DataReviewChecksFilter` `dataReviewChecks` array of string : ​ **dispositionStatus** `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ Values of `EventDispositionStatus` `EVENT_DISPOSITION_STATUS_UNSPECIFIED` : ​ `PENDING_REVIEW` : ​ `CLOSED_IGNORED` : ​ `CLOSED_REQUIRES_FURTHER_ACTION` : ​ `NO_DISPOSITION` : ​ **dispositionStatuses** `dispositionStatuses` [`EventDispositionStatusList`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatuslist) : ​ Fields of `EventDispositionStatusList` `values` array of [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ **priority** `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ **priorities** `priorities` [`PriorityList`](https://dev.nominal.io/api/rest/event-service.md#prioritylist) : ​ Fields of `PriorityList` `values` array of [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ **assignee** `assignee` string : ​ **assignees** `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/rest/event-service.md#assigneesfilter) : ​ Fields of `AssigneesFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `assignees` array of string : ​ **eventType** `eventType` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ **eventTypes** `eventTypes` [`EventTypeList`](https://dev.nominal.io/api/rest/event-service.md#eventtypelist) : ​ Fields of `EventTypeList` `values` array of [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ **createdBy** `createdBy` string : ​ **createdByAnyOf** `createdByAnyOf` [`UserRidList`](https://dev.nominal.io/api/rest/event-service.md#userridlist) : ​ Fields of `UserRidList` `values` array of string : ​ **label** `label` string : ​ **labels** `labels` [`LabelsFilter`](https://dev.nominal.io/api/rest/event-service.md#labelsfilter) : ​ Fields of `LabelsFilter` `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `labels` array of string : ​ **property** `property` [`Property`](https://dev.nominal.io/api/rest/event-service.md#property) : ​ Fields of `Property` `name` string : ​ `value` string : ​ **properties** `properties` [`PropertiesFilter`](https://dev.nominal.io/api/rest/event-service.md#propertiesfilter) : ​ Fields of `PropertiesFilter` `name` string : ​ `values` array of string : ​ **and** `and` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ Fields of `SearchQueryList` `queries` array of [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **or** `or` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ **not** `not` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **workspace** `workspace` string : ​ **procedure** `procedure` string : ​ **procedureExecution** `procedureExecution` string : ​ **stepId** `stepId` string : ​ **streamingChecklist** `streamingChecklist` string : Filters to events created from a checklist executing in streaming. **streamingCheck** `streamingCheck` string : Filters to events created from the check of a checklist executing in streaming. **numericProperty** `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertypredicate) : Matches events using a numeric property comparison. Fields of `NumericPropertyPredicate` `name` string : ​ `value` number : ​ `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/rest/event-service.md#propertycomparisonoperator) : ​ Values of `PropertyComparisonOperator` `PROPERTY_COMPARISON_OPERATOR_UNSPECIFIED` : ​ `EQ` : ​ `NEQ` : ​ `GT` : ​ `GTE` : ​ `LT` : ​ `LTE` : ​ **numericPropertyRange** `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangepredicate) : Matches events using an inclusive numeric property range. Fields of `NumericPropertyRangePredicate` `name` string : ​ `min` number : ​ `max` number : ​ `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangeoperator) : ​ Values of `NumericPropertyRangeOperator` `NUMERIC_PROPERTY_RANGE_OPERATOR_UNSPECIFIED` : ​ `BETWEEN` : ​ `NOT_BETWEEN` : ​ `archivedStatuses` array of [`ArchivedStatus`](https://dev.nominal.io/api/rest/event-service.md#archivedstatus) : If empty, defaults to NOT_ARCHIVED only. Allows including archived events in search. Values of `ArchivedStatus` `ARCHIVED_STATUS_UNSPECIFIED` : ​ `NOT_ARCHIVED` : ​ `ARCHIVED` : ​ Response `results` array of [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : ​ Fields of `Event` `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ `nextPageToken` string : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/search" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "sort": { "isDescending": true, "field": "START_TIME" }, "pageSize": 1, "nextPageToken": "", "query": { "archived": true }, "archivedStatuses": [ "NOT_ARCHIVED" ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/search", headers={"Authorization": "Bearer "}, json={ "sort": {"isDescending": True, "field": "START_TIME"}, "pageSize": 1, "nextPageToken": "", "query": {"archived": True}, "archivedStatuses": ["NOT_ARCHIVED"], }, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/search", headers={"Authorization": "Bearer "}, json={ "sort": {"isDescending": True, "field": "START_TIME"}, "pageSize": 1, "nextPageToken": "", "query": {"archived": True}, "archivedStatuses": ["NOT_ARCHIVED"], }, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/search", headers={"Authorization": "Bearer "}, json={ "sort": {"isDescending": True, "field": "START_TIME"}, "pageSize": 1, "nextPageToken": "", "query": {"archived": True}, "archivedStatuses": ["NOT_ARCHIVED"], }, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "results": [ { "uuid": "", "rid": "", "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "isArchived": true, "createdBy": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } } ], "nextPageToken": "" } ``` ### Update event POST `/event/v2/events/update` Updates the fields of an event. Empty fields are left unchanged. Body `uuid` string : ​ `rid` string : The unique identifier for the event. Required if the uuid field is not provided. `assetRids` [`AssetRidSet`](https://dev.nominal.io/api/rest/event-service.md#assetridset) : If provided, replaces the existing asset rids. If provided, must contain at least one asset rid. Fields of `AssetRidSet` `assetRids` array of string : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` [`LabelUpdateWrapper`](https://dev.nominal.io/api/rest/event-service.md#labelupdatewrapper) : ​ Fields of `LabelUpdateWrapper` `labels` array of string : ​ `properties` [`PropertyUpdateWrapper`](https://dev.nominal.io/api/rest/event-service.md#propertyupdatewrapper) deprecated : ​ Fields of `PropertyUpdateWrapper` `properties` map of string to string : ​ `typedProperties` [`TypedPropertyUpdateWrapper`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyupdatewrapper) : ​ Fields of `TypedPropertyUpdateWrapper` `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` required : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Response `event` [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : ​ Fields of `Event` `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. Fields of `EventOrigin` one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. Fields of `WorkbookEventOrigin` `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Fields of `WorkbookDataAssociation` `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ Fields of `TimeSeriesChannelAssociation` `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. Fields of `TemplateEventOrigin` `rid` string : ​ **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. Fields of `DataReviewEventOrigin` `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. Fields of `CheckOriginMetadata` `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. Fields of `ProcedureEventOrigin` `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. Fields of `StreamingChecklistEventOrigin` `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. Fields of `StreamingCheckOriginMetadata` `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ Fields of `Timestamp` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ Fields of `Duration` `seconds` string (int64) : ​ `nanos` string (int64) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ Values of `EventType` `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ Fields of `EventDisposition` `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ Values of `Priority` `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ Fields of `DispositionState` one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ Fields of `PendingReviewDispositionState` `openedBy` string : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ Fields of `ClosedWithFurtherActionDispositionState` `closedBy` string : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ Fields of `ClosedWithIgnoreDispositionState` `closedBy` string : ​ `assignees` array of string : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ Fields of `TypedPropertyValue` one of `stringValue`, `numericValue` : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/events/update" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "uuid": "", "rid": "", "assetRids": { "assetRids": [ "" ] }, "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": { "labels": [ "" ] }, "properties": { "properties": { "": "" } }, "typedProperties": { "typedProperties": { "": { "stringValue": "" } } } }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/events/update", headers={"Authorization": "Bearer "}, json={ "uuid": "", "rid": "", "assetRids": {"assetRids": [""]}, "timestamp": {"seconds": "1", "nanos": "1"}, "duration": {"seconds": "1", "nanos": "1"}, "name": "", "description": "", "type": "INFO", "labels": {"labels": [""]}, "properties": {"properties": {"": ""}}, "typedProperties": { "typedProperties": {"": {"stringValue": ""}}, }, }, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/events/update", headers={"Authorization": "Bearer "}, json={ "uuid": "", "rid": "", "assetRids": {"assetRids": [""]}, "timestamp": {"seconds": "1", "nanos": "1"}, "duration": {"seconds": "1", "nanos": "1"}, "name": "", "description": "", "type": "INFO", "labels": {"labels": [""]}, "properties": {"properties": {"": ""}}, "typedProperties": { "typedProperties": {"": {"stringValue": ""}}, }, }, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/events/update", headers={"Authorization": "Bearer "}, json={ "uuid": "", "rid": "", "assetRids": {"assetRids": [""]}, "timestamp": {"seconds": "1", "nanos": "1"}, "duration": {"seconds": "1", "nanos": "1"}, "name": "", "description": "", "type": "INFO", "labels": {"labels": [""]}, "properties": {"properties": {"": ""}}, "typedProperties": { "typedProperties": {"": {"stringValue": ""}}, }, }, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "event": { "uuid": "", "rid": "", "assetRids": [ "" ], "origins": [ { "workbook": { "rid": "", "data": [ { "timeSeriesChannel": { "variableName": "", "tags": { "": "" } } } ] } } ], "timestamp": { "seconds": "1", "nanos": "1" }, "duration": { "seconds": "1", "nanos": "1" }, "name": "", "description": "", "type": "INFO", "labels": [ "" ], "properties": { "": "" }, "isArchived": true, "createdBy": "", "disposition": { "priority": "P0", "state": { "pendingReview": { "openedBy": "" } }, "assignees": [ "" ] }, "typedProperties": { "": { "stringValue": "" } } } } ``` ### List properties and labels POST `/event/v2/list-properties-labels` Lists the properties and labels of active events in the provided workspaces. Body `workspaceRids` array of string : If empty, results come from all workspaces the user belongs to. Response `properties` map of string to [`PropertyValues`](https://dev.nominal.io/api/rest/event-service.md#propertyvalues) deprecated : Deprecated: use the paginated SearchPropertyKeys and SearchPropertyValues methods instead. Legacy string-only property values. proto3 forbids a repeated map value, so the property values are wrapped. Fields of `PropertyValues` `value` array of string : ​ `labels` array of string : ​ Request **curl** ```shell curl -X POST "https://api.gov.nominal.io/api/event/v2/list-properties-labels" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ --data '{ "workspaceRids": [ "" ] }' ``` **requests** ```python import requests response = requests.post( "https://api.gov.nominal.io/api/event/v2/list-properties-labels", headers={"Authorization": "Bearer "}, json={"workspaceRids": [""]}, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.post( "https://api.gov.nominal.io/api/event/v2/list-properties-labels", headers={"Authorization": "Bearer "}, json={"workspaceRids": [""]}, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.post( "https://api.gov.nominal.io/api/event/v2/list-properties-labels", headers={"Authorization": "Bearer "}, json={"workspaceRids": [""]}, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "properties": { "": { "value": [ "" ] } }, "labels": [ "" ] } ``` ## Errors [Errors](https://dev.nominal.io/api.md#errors) shows how these errors are sent. Each error’s `errorName` is `NominalEventV2:` followed by its name below. | Status | Name | Notes | | --- | --- | --- | | 400 | `EventErrorFindEventsIndexInvalid` | FindEventsIndexInvalid | | 400 | `EventErrorFindEventsQueryCountTooLarge` | FindEventsQueryCountTooLarge | | 400 | `EventErrorInvalidEventRequest` | InvalidEventRequest | | 400 | `EventErrorSearchQueryTooBroad` | EventSearchQueryTooBroad | ## Types ### AggregateEventsRequest `query` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ `aggregateTypes` array of [`AggregateType`](https://dev.nominal.io/api/rest/event-service.md#aggregatetype) : ​ ### AggregateEventsResponse `values` map of string to [`AggregateValue`](https://dev.nominal.io/api/rest/event-service.md#aggregatevalue) : Keyed by AggregateType enum value name (proto3 forbids enum map keys). ### AggregateType `AGGREGATE_TYPE_UNSPECIFIED` : ​ `TOTAL_DURATION` : ​ `TOTAL_COUNT` : ​ ### AggregateValue Set at most one of the fields below. one of `duration`, `count` : ​ **duration** `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ **count** `count` integer : ​ ### ApiEventOrigin An empty JSON object, `{}`. ### ArchivedStatus `ARCHIVED_STATUS_UNSPECIFIED` : ​ `NOT_ARCHIVED` : ​ `ARCHIVED` : ​ ### AssetRidSet Optional collection presence: an absent wrapper leaves the field untouched, a present (even empty) wrapper replaces it — matching the classic REST optional/optional update semantics. `assetRids` array of string : ​ ### AssetsFilter `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `assets` array of string : ​ ### AssigneesFilter `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `assignees` array of string : ​ ### CheckOriginMetadata `checkEvaluationRid` string : ​ `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ ### ClosedWithFurtherActionDispositionState `closedBy` string : ​ ### ClosedWithIgnoreDispositionState `closedBy` string : ​ ### DataReviewChecksFilter `dataReviewChecks` array of string : ​ ### DataReviewEventOrigin `dataReviewRid` string : ​ `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#checkoriginmetadata) : Metadata about the check that created this event. ### DataReviewsFilter `dataReviews` array of string : ​ ### DispositionState Set at most one of the fields below. one of `pendingReview`, `closedWithFurtherAction`, `closedWithIgnore` : ​ **pendingReview** `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/rest/event-service.md#pendingreviewdispositionstate) : ​ **closedWithFurtherAction** `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithfurtheractiondispositionstate) : ​ **closedWithIgnore** `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/rest/event-service.md#closedwithignoredispositionstate) : ​ ### Duration `seconds` string (int64) : ​ `nanos` string (int64) : ​ ### Event `uuid` string : ​ `rid` string : ​ `assetRids` array of string : A set of asset rids associated with the event. `origins` array of [`EventOrigin`](https://dev.nominal.io/api/rest/event-service.md#eventorigin) : A set of origins associated with the event. `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ `labels` array of string : ​ `properties` map of string to string deprecated : ​ `isArchived` boolean : ​ `createdBy` string : The user who created the event. This field may be missing for legacy events. `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : ​ `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ ### EventDisposition Describes the review status for an event. `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ `state` [`DispositionState`](https://dev.nominal.io/api/rest/event-service.md#dispositionstate) : ​ `assignees` array of string : ​ ### EventDispositionStatus `EVENT_DISPOSITION_STATUS_UNSPECIFIED` : ​ `PENDING_REVIEW` : ​ `CLOSED_IGNORED` : ​ `CLOSED_REQUIRES_FURTHER_ACTION` : ​ `NO_DISPOSITION` : ​ ### EventDispositionStatusList `values` array of [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ ### EventOrigin Describes where an event came from. Set at most one of the fields below. one of 6 fields : ​ **workbook** `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#workbookeventorigin) : This event was created in this workbook. **template** `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#templateeventorigin) : This event was created in this template. **api** `api` [`ApiEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#apieventorigin) : This event was created programmatically via the API. **dataReview** `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#datarevieweventorigin) : This event was created automatically from a checklist execution. **procedure** `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#procedureeventorigin) : This event was created automatically from a procedure execution. **streamingChecklist** `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/rest/event-service.md#streamingchecklisteventorigin) : This event was created automatically from the execution of a streaming checklist. ### EventsHistogramBucket `startInclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `endExclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `count` integer : ​ ### EventTimeFilter `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/rest/event-service.md#eventtimefiltercondition) : ​ ### EventTimeFilterCondition `EVENT_TIME_FILTER_CONDITION_UNSPECIFIED` : ​ `START_TIME_BEFORE_INCLUSIVE` : ​ `START_TIME_BEFORE_EXCLUSIVE` : ​ `START_TIME_AFTER_INCLUSIVE` : ​ `START_TIME_AFTER_EXCLUSIVE` : ​ `END_TIME_BEFORE_INCLUSIVE` : ​ `END_TIME_BEFORE_EXCLUSIVE` : ​ `END_TIME_AFTER_INCLUSIVE` : ​ `END_TIME_AFTER_EXCLUSIVE` : ​ ### EventType `EVENT_TYPE_UNSPECIFIED` : ​ `INFO` : ​ `FLAG` : ​ `ERROR` : ​ `SUCCESS` : ​ ### EventTypeList `values` array of [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ ### EventUpdate `rid` string : ​ `assetRids` [`AssetRidSet`](https://dev.nominal.io/api/rest/event-service.md#assetridset) : If provided, replaces the existing asset rids. If provided, must contain at least one asset rid. `timestamp` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `duration` [`Duration`](https://dev.nominal.io/api/rest/event-service.md#duration) : ​ `name` string : ​ `description` string : ​ `type` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ `labels` [`LabelUpdateWrapper`](https://dev.nominal.io/api/rest/event-service.md#labelupdatewrapper) : ​ `properties` [`PropertyUpdateWrapper`](https://dev.nominal.io/api/rest/event-service.md#propertyupdatewrapper) deprecated : ​ `typedProperties` [`TypedPropertyUpdateWrapper`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyupdatewrapper) : ​ ### FindEventsQuery `assetRids` array of string : When non-empty, only events associated with at least one of these assets match. When empty, events match on the time window alone. `startInclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Half-open window [start_inclusive, end_exclusive) over event start times. An absent bound leaves that side of the window open. `endExclusive` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : ​ `index` integer : Zero-based rank of the event to return after applying the request sort and permission filtering. Must be non-negative. When permission filtering hides events within the first index matches, the result may be absent even though later matches exist. ### FindEventsResult `event` [`Event`](https://dev.nominal.io/api/rest/event-service.md#event) : Absent when no event matches the query at the requested index. ### HistogramFilterQuery Set at most one of the fields below. one of 21 fields : ​ **searchText** `searchText` string : ​ **asset** `asset` string : ​ **template** `template` string : ​ **workbook** `workbook` string : ​ **dataReview** `dataReview` string : ​ **originType** `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ **dataReviewCheck** `dataReviewCheck` string : ​ **dispositionStatus** `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ **priority** `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ **assignee** `assignee` string : ​ **eventType** `eventType` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ **createdBy** `createdBy` string : ​ **label** `label` string : ​ **property** `property` [`Property`](https://dev.nominal.io/api/rest/event-service.md#property) : ​ **and** `and` [`HistogramFilterQueryList`](https://dev.nominal.io/api/rest/event-service.md#histogramfilterquerylist) : ​ **or** `or` [`HistogramFilterQueryList`](https://dev.nominal.io/api/rest/event-service.md#histogramfilterquerylist) : ​ **not** `not` [`HistogramFilterQuery`](https://dev.nominal.io/api/rest/event-service.md#histogramfilterquery) : ​ **workspace** `workspace` string : ​ **procedure** `procedure` string : ​ **procedureExecution** `procedureExecution` string : ​ **stepId** `stepId` string : ​ ### HistogramFilterQueryList `queries` array of [`HistogramFilterQuery`](https://dev.nominal.io/api/rest/event-service.md#histogramfilterquery) : ​ ### LabelsFilter `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `labels` array of string : ​ ### LabelUpdateWrapper Wrapper classes to allow for optional fields on update requests `labels` array of string : ​ ### NumericPropertyPredicate Matches resources that have a numeric value for the named property and whose value satisfies the operator. NEQ excludes resources that lack the property or store a string value under the same name. `name` string : ​ `value` number : ​ `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/rest/event-service.md#propertycomparisonoperator) : ​ ### NumericPropertyRangeOperator `NUMERIC_PROPERTY_RANGE_OPERATOR_UNSPECIFIED` : ​ `BETWEEN` : ​ `NOT_BETWEEN` : ​ ### NumericPropertyRangePredicate Inclusive range on a numeric property. At least one bound is required. BETWEEN: min <= x <= max. An absent bound is unbounded on that side. NOT_BETWEEN: x < min OR x > max. An absent bound drops that side. Both operators require a numeric value for `name`. Missing properties and string values never match. Bounds are closed [min, max] to match the number chip (is between / is not between), not half-open. `name` string : ​ `min` number : ​ `max` number : ​ `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangeoperator) : ​ ### OriginTypesFilter `operator` [`SetOperator`](https://dev.nominal.io/api/rest/event-service.md#setoperator) : ​ `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ ### PendingReviewDispositionState `openedBy` string : ​ ### Priority `PRIORITY_UNSPECIFIED` : ​ `P0` : ​ `P1` : ​ `P2` : ​ `P3` : ​ `P4` : ​ ### PriorityList `values` array of [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ ### ProcedureEventOrigin `procedureExecutionRid` string : ​ `procedureRid` string : ​ `stepId` string : ​ ### PropertiesFilter `name` string : ​ `values` array of string : ​ ### Property `name` string : ​ `value` string : ​ ### PropertyComparisonOperator `PROPERTY_COMPARISON_OPERATOR_UNSPECIFIED` : ​ `EQ` : ​ `NEQ` : ​ `GT` : ​ `GTE` : ​ `LT` : ​ `LTE` : ​ ### PropertyUpdateWrapper `properties` map of string to string : ​ ### PropertyValues `value` array of string : ​ ### SearchEventOriginType `SEARCH_EVENT_ORIGIN_TYPE_UNSPECIFIED` : ​ `WORKBOOK` : ​ `TEMPLATE` : ​ `API` : ​ `DATA_REVIEW` : ​ `PROCEDURE` : ​ `STREAMING_CHECKLIST` : ​ ### SearchQuery Set at most one of the fields below. one of 41 fields : ​ **archived** `archived` boolean : ​ **searchText** `searchText` string : Search text to perform fuzzy searching against. **exactMatch** `exactMatch` string : Search text to perform exact matching against on the event name and description. **after** `after` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events after this timestamp, exclusive. **before** `before` [`Timestamp`](https://dev.nominal.io/api/rest/event-service.md#timestamp) : Filters to events before this timestamp, exclusive. **advancedTimeFilter** `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/rest/event-service.md#eventtimefilter) : ​ **asset** `asset` string : ​ **assets** `assets` [`AssetsFilter`](https://dev.nominal.io/api/rest/event-service.md#assetsfilter) : ​ **template** `template` string : ​ **workbook** `workbook` string : ​ **dataReview** `dataReview` string : ​ **dataReviews** `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewsfilter) : ​ **originType** `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/rest/event-service.md#searcheventorigintype) : ​ **originTypes** `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/rest/event-service.md#origintypesfilter) : ​ **dataReviewCheck** `dataReviewCheck` string : ​ **dataReviewChecks** `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/rest/event-service.md#datareviewchecksfilter) : ​ **dispositionStatus** `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatus) : ​ **dispositionStatuses** `dispositionStatuses` [`EventDispositionStatusList`](https://dev.nominal.io/api/rest/event-service.md#eventdispositionstatuslist) : ​ **priority** `priority` [`Priority`](https://dev.nominal.io/api/rest/event-service.md#priority) : ​ **priorities** `priorities` [`PriorityList`](https://dev.nominal.io/api/rest/event-service.md#prioritylist) : ​ **assignee** `assignee` string : ​ **assignees** `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/rest/event-service.md#assigneesfilter) : ​ **eventType** `eventType` [`EventType`](https://dev.nominal.io/api/rest/event-service.md#eventtype) : ​ **eventTypes** `eventTypes` [`EventTypeList`](https://dev.nominal.io/api/rest/event-service.md#eventtypelist) : ​ **createdBy** `createdBy` string : ​ **createdByAnyOf** `createdByAnyOf` [`UserRidList`](https://dev.nominal.io/api/rest/event-service.md#userridlist) : ​ **label** `label` string : ​ **labels** `labels` [`LabelsFilter`](https://dev.nominal.io/api/rest/event-service.md#labelsfilter) : ​ **property** `property` [`Property`](https://dev.nominal.io/api/rest/event-service.md#property) : ​ **properties** `properties` [`PropertiesFilter`](https://dev.nominal.io/api/rest/event-service.md#propertiesfilter) : ​ **and** `and` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ **or** `or` [`SearchQueryList`](https://dev.nominal.io/api/rest/event-service.md#searchquerylist) : ​ **not** `not` [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ **workspace** `workspace` string : ​ **procedure** `procedure` string : ​ **procedureExecution** `procedureExecution` string : ​ **stepId** `stepId` string : ​ **streamingChecklist** `streamingChecklist` string : Filters to events created from a checklist executing in streaming. **streamingCheck** `streamingCheck` string : Filters to events created from the check of a checklist executing in streaming. **numericProperty** `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertypredicate) : Matches events using a numeric property comparison. **numericPropertyRange** `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/rest/event-service.md#numericpropertyrangepredicate) : Matches events using an inclusive numeric property range. ### SearchQueryList Repeated-value arms of the SearchQuery / HistogramFilterQuery oneofs are message-wrapped: proto3 oneof arms cannot be repeated directly. `queries` array of [`SearchQuery`](https://dev.nominal.io/api/rest/event-service.md#searchquery) : ​ ### SetOperator `SET_OPERATOR_UNSPECIFIED` : ​ `AND` : ​ `OR` : ​ ### SortField `SORT_FIELD_UNSPECIFIED` : ​ `START_TIME` : ​ `END_TIME` : ​ `DURATION` : ​ `DISPOSITION_STATUS` : ​ `PRIORITY` : ​ `EVENT_NAME` : ​ ### SortOptions `isDescending` boolean : ​ `field` [`SortField`](https://dev.nominal.io/api/rest/event-service.md#sortfield) : ​ ### StreamingChecklistEventOrigin `checklistRid` string : ​ `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/rest/event-service.md#streamingcheckoriginmetadata) : Metadata about the check that created this event. ### StreamingCheckOriginMetadata `checkRid` string : ​ `checkLineageRid` string : ​ `implementationIndex` integer : ​ ### TemplateEventOrigin `rid` string : ​ ### TimeSeriesChannelAssociation A singular time series to associate the event with. `variableName` string : ​ `tags` map of string to string : If this variable is grouped, the tags within the groupings this event should associate with. ### Timestamp Deprecated for new APIs. Use google.protobuf.Timestamp for absolute instants. This legacy nanosecond-precision timestamp is represented by an epoch time in seconds and a nanosecond offset. The nanosecond offset is from the start of the epoch second, so must be less than 1 billion. `seconds` string (int64) : ​ `nanos` string (int64) : ​ ### TypedPropertyUpdateWrapper `typedProperties` map of string to [`TypedPropertyValue`](https://dev.nominal.io/api/rest/event-service.md#typedpropertyvalue) : ​ ### TypedPropertyValue Set exactly one of the fields below. one of `stringValue`, `numericValue` required : ​ **stringValue** `stringValue` string : ​ **numericValue** `numericValue` number : ​ ### UpdateDispositionRequest `rid` string : ​ `disposition` [`EventDisposition`](https://dev.nominal.io/api/rest/event-service.md#eventdisposition) : The new disposition for the event. If empty, removes the disposition from the event. ### UserRidList `values` array of string : ​ ### WorkbookDataAssociation `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/rest/event-service.md#timeserieschannelassociation) : ​ ### WorkbookEventOrigin `rid` string : ​ `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/rest/event-service.md#workbookdataassociation) : Data visualizations to associate this event with. Page design based on [Scalar](https://scalar.com), MIT License.