# 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: [`EventService.json`](https://dev.nominal.io/api/_downloads/27a7ab7b6d74f02a29f04f1a71d15fb1/EventService.json)

## Endpoints

### Create event

POST `/event/v1/events`

Creates an event.

Body

`assetRids` array of string (RID)
:   Must contain at least one asset rid.

`origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
:   If empty, will default to set<EventOrigin.api>.

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
    :   This event was created in this workbook

        Fields of `WorkbookEventOrigin`

        `rid` string (RID) required
        :   ​

        `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
        :   Data visualizations to associate this event with

            **timeSeriesChannel**

            Set `type` to `"timeSeriesChannel"`.

            `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/event-service.md#timeserieschannelassociation)
            :   ​

                Fields of `TimeSeriesChannelAssociation`

                `variableName` string required
                :   ​

                `tags` map of string to string
                :   If this variable is grouped, the tags within the groupings this event should associate with

    **template**

    Set `type` to `"template"`.

    `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
    :   This event was created in this template

        Fields of `TemplateEventOrigin`

        `rid` string (RID) required
        :   ​

    **api**

    Set `type` to `"api"`.

    `api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
    :   This event was created programmatically via the API

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
    :   This event was created automatically from a checklist execution.

        Fields of `DataReviewEventOrigin`

        `dataReviewRid` string (RID) required
        :   ​

        `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata) required
        :   Metadata about the check that created this event.

            Fields of `CheckOriginMetadata`

            `checkEvaluationRid` string (RID) required
            :   ​

            `checkRid` string (RID) required
            :   ​

            `checkLineageRid` string (RID) required
            :   ​

            `implementationIndex` integer
            :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
    :   This event was created automatically from a procedure execution.

        Fields of `ProcedureEventOrigin`

        `procedureExecutionRid` string (RID) required
        :   ​

        `procedureRid` string (RID) required
        :   ​

        `stepId` string required
        :   ​

    **streamingChecklist**

    Set `type` to `"streamingChecklist"`.

    `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
    :   This event was created automatically from the execution of a streaming checklist.

        Fields of `StreamingChecklistEventOrigin`

        `checklistRid` string (RID) required
        :   ​

        `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata) required
        :   Metadata about the check that created this event.

            Fields of `StreamingCheckOriginMetadata`

            `checkRid` string (RID) required
            :   ​

            `checkLineageRid` string (RID) required
            :   ​

            `implementationIndex` integer
            :   ​

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
:   ​

    Fields of `Timestamp`

    `seconds` integer (int64) required
    :   ​

    `nanos` integer (int64) required
    :   ​

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration) required
:   ​

    Fields of `Duration`

    `seconds` integer (int64) required
    :   ​

    `nanos` integer (int64) required
    :   ​

`name` string required
:   ​

`description` string
:   If not provided, will default to an empty string.

`type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype) required
:   ​

    Values of `EventType`

    `INFO`
    :   ​

    `FLAG`
    :   ​

    `ERROR`
    :   ​

    `SUCCESS`
    :   ​

`labels` array of string
:   ​

`properties` map of `PropertyName` to string deprecated
:   **Deprecated:** use typedProperties

`typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
:   ​

    **stringValue**

    Set `type` to `"stringValue"`.

    `stringValue` string
    :   ​

    **numericValue**

    Set `type` to `"numericValue"`.

    `numericValue` number
    :   ​

`disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
:   ​

    Fields of `EventDisposition`

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority) required
    :   ​

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate) required
    :   ​

        **pendingReview**

        Set `type` to `"pendingReview"`.

        `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
        :   ​

            Fields of `PendingReviewDispositionState`

            `openedBy` string (RID) required
            :   ​

        **closedWithFurtherAction**

        Set `type` to `"closedWithFurtherAction"`.

        `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
        :   ​

            Fields of `ClosedWithFurtherActionDispositionState`

            `closedBy` string (RID) required
            :   ​

        **closedWithIgnore**

        Set `type` to `"closedWithIgnore"`.

        `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
        :   ​

            Fields of `ClosedWithIgnoreDispositionState`

            `closedBy` string (RID) required
            :   ​

    `assignees` array of string (RID)
    :   ​

Response

`uuid` string (UUID) deprecated
:   **Deprecated:** This field is deprecated. Use the rid field instead.

`rid` string (RID)
:   ​

`assetRids` array of string (RID)
:   A set of asset rids associated with the event.

`origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
:   A set of origins associated with the event.

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
    :   This event was created in this workbook

        Fields of `WorkbookEventOrigin`

        `rid` string (RID)
        :   ​

        `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
        :   Data visualizations to associate this event with

            **timeSeriesChannel**

            Set `type` to `"timeSeriesChannel"`.

            `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/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**

    Set `type` to `"template"`.

    `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
    :   This event was created in this template

        Fields of `TemplateEventOrigin`

        `rid` string (RID)
        :   ​

    **api**

    Set `type` to `"api"`.

    `api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
    :   This event was created programmatically via the API

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
    :   This event was created automatically from a checklist execution.

        Fields of `DataReviewEventOrigin`

        `dataReviewRid` string (RID)
        :   ​

        `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `CheckOriginMetadata`

            `checkEvaluationRid` string (RID)
            :   ​

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
    :   This event was created automatically from a procedure execution.

        Fields of `ProcedureEventOrigin`

        `procedureExecutionRid` string (RID)
        :   ​

        `procedureRid` string (RID)
        :   ​

        `stepId` string
        :   ​

    **streamingChecklist**

    Set `type` to `"streamingChecklist"`.

    `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
    :   This event was created automatically from the execution of a streaming checklist.

        Fields of `StreamingChecklistEventOrigin`

        `checklistRid` string (RID)
        :   ​

        `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `StreamingCheckOriginMetadata`

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
:   ​

    Fields of `Timestamp`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
:   ​

    Fields of `Duration`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`name` string
:   ​

`description` string
:   ​

`type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
:   ​

    Values of `EventType`

    `INFO`
    :   ​

    `FLAG`
    :   ​

    `ERROR`
    :   ​

    `SUCCESS`
    :   ​

`labels` array of string
:   ​

`properties` map of `PropertyName` to string deprecated
:   **Deprecated:** use typedProperties

`typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
:   ​

    **stringValue**

    Set `type` to `"stringValue"`.

    `stringValue` string
    :   ​

    **numericValue**

    Set `type` to `"numericValue"`.

    `numericValue` number
    :   ​

`isArchived` boolean
:   ​

`createdBy` string (RID)
:   The user who created the event. This field may be missing for legacy events.

`disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
:   ​

    Fields of `EventDisposition`

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
    :   ​

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate)
    :   ​

        **pendingReview**

        Set `type` to `"pendingReview"`.

        `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
        :   ​

            Fields of `PendingReviewDispositionState`

            `openedBy` string (RID)
            :   ​

        **closedWithFurtherAction**

        Set `type` to `"closedWithFurtherAction"`.

        `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
        :   ​

            Fields of `ClosedWithFurtherActionDispositionState`

            `closedBy` string (RID)
            :   ​

        **closedWithIgnore**

        Set `type` to `"closedWithIgnore"`.

        `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
        :   ​

            Fields of `ClosedWithIgnoreDispositionState`

            `closedBy` string (RID)
            :   ​

    `assignees` array of string (RID)
    :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/events" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "timestamp": {
    "seconds": 1,
    "nanos": 1
  },
  "duration": {
    "seconds": 1,
    "nanos": 1
  },
  "name": "<name>",
  "type": "INFO"
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/events",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "timestamp": {"seconds": 1, "nanos": 1},
        "duration": {"seconds": 1, "nanos": 1},
        "name": "<name>",
        "type": "INFO",
    },
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/events",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "timestamp": {"seconds": 1, "nanos": 1},
        "duration": {"seconds": 1, "nanos": 1},
        "name": "<name>",
        "type": "INFO",
    },
)
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/v1/events",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "timestamp": {"seconds": 1, "nanos": 1},
                "duration": {"seconds": 1, "nanos": 1},
                "name": "<name>",
                "type": "INFO",
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
{
  "uuid": "<uuid>",
  "rid": "<event rid>",
  "assetRids": [
    "<asset rid>"
  ],
  "origins": [
    {
      "type": "workbook",
      "workbook": {
        "rid": "<notebook rid>",
        "data": [
          {
            "type": "timeSeriesChannel",
            "timeSeriesChannel": {
              "variableName": "<variable name>",
              "tags": {
                "<key>": "<value>"
              }
            }
          }
        ]
      }
    }
  ],
  "timestamp": {
    "seconds": 1,
    "nanos": 1
  },
  "duration": {
    "seconds": 1,
    "nanos": 1
  },
  "name": "<name>",
  "description": "<description>",
  "type": "INFO",
  "labels": [
    "<label>"
  ],
  "properties": {
    "<key>": "<property value>"
  },
  "typedProperties": {
    "<key>": {
      "type": "stringValue",
      "stringValue": "<property value>"
    }
  },
  "isArchived": true,
  "createdBy": "<user rid>",
  "disposition": {
    "priority": "P0",
    "state": {
      "type": "pendingReview",
      "pendingReview": {
        "openedBy": "<user rid>"
      }
    },
    "assignees": [
      "<user rid>"
    ]
  }
}
```

### Get events

POST `/event/v1/get-events`

**Deprecated:** This endpoint is deprecated. Use the batchGetEvents endpoint instead.

Gets a set of events by UUIDs

Body

`uuids` array of string (UUID)
:   ​

Response

The body is an array of [`Event`](https://dev.nominal.io/api/legacy/event-service.md#event).

Fields of `Event`

`uuid` string (UUID) deprecated
:   **Deprecated:** This field is deprecated. Use the rid field instead.

`rid` string (RID)
:   ​

`assetRids` array of string (RID)
:   A set of asset rids associated with the event.

`origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
:   A set of origins associated with the event.

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
    :   This event was created in this workbook

        Fields of `WorkbookEventOrigin`

        `rid` string (RID)
        :   ​

        `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
        :   Data visualizations to associate this event with

            **timeSeriesChannel**

            Set `type` to `"timeSeriesChannel"`.

            `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/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**

    Set `type` to `"template"`.

    `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
    :   This event was created in this template

        Fields of `TemplateEventOrigin`

        `rid` string (RID)
        :   ​

    **api**

    Set `type` to `"api"`.

    `api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
    :   This event was created programmatically via the API

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
    :   This event was created automatically from a checklist execution.

        Fields of `DataReviewEventOrigin`

        `dataReviewRid` string (RID)
        :   ​

        `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `CheckOriginMetadata`

            `checkEvaluationRid` string (RID)
            :   ​

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
    :   This event was created automatically from a procedure execution.

        Fields of `ProcedureEventOrigin`

        `procedureExecutionRid` string (RID)
        :   ​

        `procedureRid` string (RID)
        :   ​

        `stepId` string
        :   ​

    **streamingChecklist**

    Set `type` to `"streamingChecklist"`.

    `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
    :   This event was created automatically from the execution of a streaming checklist.

        Fields of `StreamingChecklistEventOrigin`

        `checklistRid` string (RID)
        :   ​

        `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `StreamingCheckOriginMetadata`

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
:   ​

    Fields of `Timestamp`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
:   ​

    Fields of `Duration`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`name` string
:   ​

`description` string
:   ​

`type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
:   ​

    Values of `EventType`

    `INFO`
    :   ​

    `FLAG`
    :   ​

    `ERROR`
    :   ​

    `SUCCESS`
    :   ​

`labels` array of string
:   ​

`properties` map of `PropertyName` to string deprecated
:   **Deprecated:** use typedProperties

`typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
:   ​

    **stringValue**

    Set `type` to `"stringValue"`.

    `stringValue` string
    :   ​

    **numericValue**

    Set `type` to `"numericValue"`.

    `numericValue` number
    :   ​

`isArchived` boolean
:   ​

`createdBy` string (RID)
:   The user who created the event. This field may be missing for legacy events.

`disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
:   ​

    Fields of `EventDisposition`

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
    :   ​

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate)
    :   ​

        **pendingReview**

        Set `type` to `"pendingReview"`.

        `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
        :   ​

            Fields of `PendingReviewDispositionState`

            `openedBy` string (RID)
            :   ​

        **closedWithFurtherAction**

        Set `type` to `"closedWithFurtherAction"`.

        `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
        :   ​

            Fields of `ClosedWithFurtherActionDispositionState`

            `closedBy` string (RID)
            :   ​

        **closedWithIgnore**

        Set `type` to `"closedWithIgnore"`.

        `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
        :   ​

            Fields of `ClosedWithIgnoreDispositionState`

            `closedBy` string (RID)
            :   ​

    `assignees` array of string (RID)
    :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/get-events" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "uuids": [
    "<uuids>"
  ]
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/get-events",
    headers={"Authorization": "Bearer <api key>"},
    json={"uuids": ["<uuids>"]},
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/get-events",
    headers={"Authorization": "Bearer <api key>"},
    json={"uuids": ["<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/v1/get-events",
            headers={"Authorization": "Bearer <api key>"},
            json={"uuids": ["<uuids>"]},
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
[
  {
    "uuid": "<uuid>",
    "rid": "<event rid>",
    "assetRids": [
      "<asset rid>"
    ],
    "origins": [
      {
        "type": "workbook",
        "workbook": {
          "rid": "<notebook rid>",
          "data": [
            {
              "type": "timeSeriesChannel",
              "timeSeriesChannel": {
                "variableName": "<variable name>",
                "tags": {
                  "<key>": "<value>"
                }
              }
            }
          ]
        }
      }
    ],
    "timestamp": {
      "seconds": 1,
      "nanos": 1
    },
    "duration": {
      "seconds": 1,
      "nanos": 1
    },
    "name": "<name>",
    "description": "<description>",
    "type": "INFO",
    "labels": [
      "<label>"
    ],
    "properties": {
      "<key>": "<property value>"
    },
    "typedProperties": {
      "<key>": {
        "type": "stringValue",
        "stringValue": "<property value>"
      }
    },
    "isArchived": true,
    "createdBy": "<user rid>",
    "disposition": {
      "priority": "P0",
      "state": {
        "type": "pendingReview",
        "pendingReview": {
          "openedBy": "<user rid>"
        }
      },
      "assignees": [
        "<user rid>"
      ]
    }
  }
]
```

### Batch get events

POST `/event/v1/events/batch-get`

Gets a set of events by RID.

Body

The body is an array of string (RID).

Response

The body is an array of [`Event`](https://dev.nominal.io/api/legacy/event-service.md#event).

Fields of `Event`

`uuid` string (UUID) deprecated
:   **Deprecated:** This field is deprecated. Use the rid field instead.

`rid` string (RID)
:   ​

`assetRids` array of string (RID)
:   A set of asset rids associated with the event.

`origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
:   A set of origins associated with the event.

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
    :   This event was created in this workbook

        Fields of `WorkbookEventOrigin`

        `rid` string (RID)
        :   ​

        `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
        :   Data visualizations to associate this event with

            **timeSeriesChannel**

            Set `type` to `"timeSeriesChannel"`.

            `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/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**

    Set `type` to `"template"`.

    `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
    :   This event was created in this template

        Fields of `TemplateEventOrigin`

        `rid` string (RID)
        :   ​

    **api**

    Set `type` to `"api"`.

    `api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
    :   This event was created programmatically via the API

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
    :   This event was created automatically from a checklist execution.

        Fields of `DataReviewEventOrigin`

        `dataReviewRid` string (RID)
        :   ​

        `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `CheckOriginMetadata`

            `checkEvaluationRid` string (RID)
            :   ​

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
    :   This event was created automatically from a procedure execution.

        Fields of `ProcedureEventOrigin`

        `procedureExecutionRid` string (RID)
        :   ​

        `procedureRid` string (RID)
        :   ​

        `stepId` string
        :   ​

    **streamingChecklist**

    Set `type` to `"streamingChecklist"`.

    `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
    :   This event was created automatically from the execution of a streaming checklist.

        Fields of `StreamingChecklistEventOrigin`

        `checklistRid` string (RID)
        :   ​

        `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `StreamingCheckOriginMetadata`

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
:   ​

    Fields of `Timestamp`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
:   ​

    Fields of `Duration`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`name` string
:   ​

`description` string
:   ​

`type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
:   ​

    Values of `EventType`

    `INFO`
    :   ​

    `FLAG`
    :   ​

    `ERROR`
    :   ​

    `SUCCESS`
    :   ​

`labels` array of string
:   ​

`properties` map of `PropertyName` to string deprecated
:   **Deprecated:** use typedProperties

`typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
:   ​

    **stringValue**

    Set `type` to `"stringValue"`.

    `stringValue` string
    :   ​

    **numericValue**

    Set `type` to `"numericValue"`.

    `numericValue` number
    :   ​

`isArchived` boolean
:   ​

`createdBy` string (RID)
:   The user who created the event. This field may be missing for legacy events.

`disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
:   ​

    Fields of `EventDisposition`

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
    :   ​

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate)
    :   ​

        **pendingReview**

        Set `type` to `"pendingReview"`.

        `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
        :   ​

            Fields of `PendingReviewDispositionState`

            `openedBy` string (RID)
            :   ​

        **closedWithFurtherAction**

        Set `type` to `"closedWithFurtherAction"`.

        `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
        :   ​

            Fields of `ClosedWithFurtherActionDispositionState`

            `closedBy` string (RID)
            :   ​

        **closedWithIgnore**

        Set `type` to `"closedWithIgnore"`.

        `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
        :   ​

            Fields of `ClosedWithIgnoreDispositionState`

            `closedBy` string (RID)
            :   ​

    `assignees` array of string (RID)
    :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/events/batch-get" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '[
  "<event rid>"
]'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/events/batch-get",
    headers={"Authorization": "Bearer <api key>"},
    json=["<event rid>"],
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/events/batch-get",
    headers={"Authorization": "Bearer <api key>"},
    json=["<event rid>"],
)
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/v1/events/batch-get",
            headers={"Authorization": "Bearer <api key>"},
            json=["<event rid>"],
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
[
  {
    "uuid": "<uuid>",
    "rid": "<event rid>",
    "assetRids": [
      "<asset rid>"
    ],
    "origins": [
      {
        "type": "workbook",
        "workbook": {
          "rid": "<notebook rid>",
          "data": [
            {
              "type": "timeSeriesChannel",
              "timeSeriesChannel": {
                "variableName": "<variable name>",
                "tags": {
                  "<key>": "<value>"
                }
              }
            }
          ]
        }
      }
    ],
    "timestamp": {
      "seconds": 1,
      "nanos": 1
    },
    "duration": {
      "seconds": 1,
      "nanos": 1
    },
    "name": "<name>",
    "description": "<description>",
    "type": "INFO",
    "labels": [
      "<label>"
    ],
    "properties": {
      "<key>": "<property value>"
    },
    "typedProperties": {
      "<key>": {
        "type": "stringValue",
        "stringValue": "<property value>"
      }
    },
    "isArchived": true,
    "createdBy": "<user rid>",
    "disposition": {
      "priority": "P0",
      "state": {
        "type": "pendingReview",
        "pendingReview": {
          "openedBy": "<user rid>"
        }
      },
      "assignees": [
        "<user rid>"
      ]
    }
  }
]
```

### Batch filter events

POST `/event/v1/events/batch-filter-get`

Gets a filtered set of events by RID and search filters.

Body

`eventRids` array of string (RID)
:   ​

`filterQuery` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery) required
:   ​

    **archived**

    Set `type` to `"archived"`.

    `archived` boolean
    :   ​

    **searchText**

    Set `type` to `"searchText"`.

    `searchText` string
    :   Search text to perform fuzzy searching against.

    **exactMatch**

    Set `type` to `"exactMatch"`.

    `exactMatch` string
    :   Search text to perform exact matching against on the event name and description.

    **after**

    Set `type` to `"after"`.

    `after` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   Filters to events after this timestamp, exclusive. This includes events that start before, but end after this time.

        Fields of `Timestamp`

        `seconds` integer (int64) required
        :   ​

        `nanos` integer (int64) required
        :   ​

    **before**

    Set `type` to `"before"`.

    `before` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   Filters to events before this timestamp, exclusive. This includes events that start before, but end after this time.

    **advancedTimeFilter**

    Set `type` to `"advancedTimeFilter"`.

    `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefilter)
    :   ​

        Fields of `EventTimeFilter`

        `timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
        :   ​

        `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefiltercondition) required
        :   ​

            Values of `EventTimeFilterCondition`

            `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**

    Set `type` to `"asset"`.

    `asset` string (RID) deprecated
    :   **Deprecated:** use assetRids

    **assets**

    Set `type` to `"assets"`.

    `assets` [`AssetsFilter`](https://dev.nominal.io/api/legacy/event-service.md#assetsfilter)
    :   ​

        Fields of `AssetsFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

            Values of `SetOperator`

            `AND`
            :   ​

            `OR`
            :   ​

        `assets` array of string (RID)
        :   ​

    **template**

    Set `type` to `"template"`.

    `template` string (RID)
    :   ​

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` string (RID)
    :   ​

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` string (RID) deprecated
    :   **Deprecated:** use dataReviews instead

    **dataReviews**

    Set `type` to `"dataReviews"`.

    `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewsfilter)
    :   ​

        Fields of `DataReviewsFilter`

        `dataReviews` array of string (RID)
        :   ​

    **originType**

    Set `type` to `"originType"`.

    `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype) deprecated
    :   **Deprecated:** use originTypes instead

        Values of `SearchEventOriginType`

        `WORKBOOK`
        :   ​

        `TEMPLATE`
        :   ​

        `API`
        :   ​

        `DATA_REVIEW`
        :   ​

        `PROCEDURE`
        :   ​

        `STREAMING_CHECKLIST`
        :   ​

    **originTypes**

    Set `type` to `"originTypes"`.

    `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/legacy/event-service.md#origintypesfilter)
    :   ​

        Fields of `OriginTypesFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

        `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype)
        :   ​

    **dataReviewCheck**

    Set `type` to `"dataReviewCheck"`.

    `dataReviewCheck` string (RID) deprecated
    :   **Deprecated:** use dataReviewChecks instead

    **dataReviewChecks**

    Set `type` to `"dataReviewChecks"`.

    `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewchecksfilter)
    :   ​

        Fields of `DataReviewChecksFilter`

        `dataReviewChecks` array of string (RID)
        :   ​

    **dispositionStatus**

    Set `type` to `"dispositionStatus"`.

    `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus) deprecated
    :   **Deprecated:** use dispositionStatuses instead

        Values of `EventDispositionStatus`

        `PENDING_REVIEW`
        :   ​

        `CLOSED_IGNORED`
        :   ​

        `CLOSED_REQUIRES_FURTHER_ACTION`
        :   ​

        `NO_DISPOSITION`
        :   ​

    **dispositionStatuses**

    Set `type` to `"dispositionStatuses"`.

    `dispositionStatuses` array of [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus)
    :   ​

    **priority**

    Set `type` to `"priority"`.

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority) deprecated
    :   **Deprecated:** use priorities instead

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    **priorities**

    Set `type` to `"priorities"`.

    `priorities` array of [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
    :   ​

    **assignee**

    Set `type` to `"assignee"`.

    `assignee` string (RID) deprecated
    :   **Deprecated:** use assignees instead

    **assignees**

    Set `type` to `"assignees"`.

    `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/legacy/event-service.md#assigneesfilter)
    :   ​

        Fields of `AssigneesFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

        `assignees` array of string (RID)
        :   ​

    **eventType**

    Set `type` to `"eventType"`.

    `eventType` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype) deprecated
    :   **Deprecated:** use eventTypes instead

        Values of `EventType`

        `INFO`
        :   ​

        `FLAG`
        :   ​

        `ERROR`
        :   ​

        `SUCCESS`
        :   ​

    **eventTypes**

    Set `type` to `"eventTypes"`.

    `eventTypes` array of [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
    :   ​

    **createdBy**

    Set `type` to `"createdBy"`.

    `createdBy` string (RID)
    :   ​

    **createdByAnyOf**

    Set `type` to `"createdByAnyOf"`.

    `createdByAnyOf` array of string (RID)
    :   ​

    **label**

    Set `type` to `"label"`.

    `label` string deprecated
    :   **Deprecated:** use labels instead

    **labels**

    Set `type` to `"labels"`.

    `labels` [`LabelsFilter`](https://dev.nominal.io/api/legacy/event-service.md#labelsfilter)
    :   ​

        Fields of `LabelsFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

        `labels` array of string
        :   ​

    **property**

    Set `type` to `"property"`.

    `property` [`Property`](https://dev.nominal.io/api/legacy/event-service.md#property) deprecated
    :   **Deprecated:** use properties instead

        Fields of `Property`

        `name` string required
        :   ​

        `value` string required
        :   ​

    **properties**

    Set `type` to `"properties"`.

    `properties` [`PropertiesFilter`](https://dev.nominal.io/api/legacy/event-service.md#propertiesfilter)
    :   ​

        Fields of `PropertiesFilter`

        `name` string required
        :   ​

        `values` array of string
        :   ​

    **and**

    Set `type` to `"and"`.

    `and` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
    :   ​

    **or**

    Set `type` to `"or"`.

    `or` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
    :   ​

    **not**

    Set `type` to `"not"`.

    `not` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
    :   ​

    **workspace**

    Set `type` to `"workspace"`.

    `workspace` string (RID)
    :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` string (RID)
    :   ​

    **procedureExecution**

    Set `type` to `"procedureExecution"`.

    `procedureExecution` string (RID)
    :   ​

    **stepId**

    Set `type` to `"stepId"`.

    `stepId` string
    :   ​

    **streamingChecklist**

    Set `type` to `"streamingChecklist"`.

    `streamingChecklist` string (RID)
    :   Filters to events created from a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

    **streamingCheck**

    Set `type` to `"streamingCheck"`.

    `streamingCheck` string (RID)
    :   Filters to events created from the check of a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

    **numericProperty**

    Set `type` to `"numericProperty"`.

    `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertypredicate)
    :   Matches events using a numeric property comparison.

        Fields of `NumericPropertyPredicate`

        `name` string required
        :   ​

        `value` number required
        :   ​

        `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/legacy/event-service.md#propertycomparisonoperator) required
        :   ​

            Values of `PropertyComparisonOperator`

            `EQ`
            :   ​

            `NEQ`
            :   ​

            `GT`
            :   ​

            `GTE`
            :   ​

            `LT`
            :   ​

            `LTE`
            :   ​

    **numericPropertyRange**

    Set `type` to `"numericPropertyRange"`.

    `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangepredicate)
    :   Matches events using an inclusive numeric property range.

        Fields of `NumericPropertyRangePredicate`

        `name` string required
        :   ​

        `min` number
        :   ​

        `max` number
        :   ​

        `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangeoperator) required
        :   ​

            Values of `NumericPropertyRangeOperator`

            `BETWEEN`
            :   ​

            `NOT_BETWEEN`
            :   ​

Response

The body is an array of [`Event`](https://dev.nominal.io/api/legacy/event-service.md#event).

Fields of `Event`

`uuid` string (UUID) deprecated
:   **Deprecated:** This field is deprecated. Use the rid field instead.

`rid` string (RID)
:   ​

`assetRids` array of string (RID)
:   A set of asset rids associated with the event.

`origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
:   A set of origins associated with the event.

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
    :   This event was created in this workbook

        Fields of `WorkbookEventOrigin`

        `rid` string (RID)
        :   ​

        `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
        :   Data visualizations to associate this event with

            **timeSeriesChannel**

            Set `type` to `"timeSeriesChannel"`.

            `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/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**

    Set `type` to `"template"`.

    `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
    :   This event was created in this template

        Fields of `TemplateEventOrigin`

        `rid` string (RID)
        :   ​

    **api**

    Set `type` to `"api"`.

    `api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
    :   This event was created programmatically via the API

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
    :   This event was created automatically from a checklist execution.

        Fields of `DataReviewEventOrigin`

        `dataReviewRid` string (RID)
        :   ​

        `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `CheckOriginMetadata`

            `checkEvaluationRid` string (RID)
            :   ​

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
    :   This event was created automatically from a procedure execution.

        Fields of `ProcedureEventOrigin`

        `procedureExecutionRid` string (RID)
        :   ​

        `procedureRid` string (RID)
        :   ​

        `stepId` string
        :   ​

    **streamingChecklist**

    Set `type` to `"streamingChecklist"`.

    `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
    :   This event was created automatically from the execution of a streaming checklist.

        Fields of `StreamingChecklistEventOrigin`

        `checklistRid` string (RID)
        :   ​

        `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `StreamingCheckOriginMetadata`

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
:   ​

    Fields of `Timestamp`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
:   ​

    Fields of `Duration`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`name` string
:   ​

`description` string
:   ​

`type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
:   ​

    Values of `EventType`

    `INFO`
    :   ​

    `FLAG`
    :   ​

    `ERROR`
    :   ​

    `SUCCESS`
    :   ​

`labels` array of string
:   ​

`properties` map of `PropertyName` to string deprecated
:   **Deprecated:** use typedProperties

`typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
:   ​

    **stringValue**

    Set `type` to `"stringValue"`.

    `stringValue` string
    :   ​

    **numericValue**

    Set `type` to `"numericValue"`.

    `numericValue` number
    :   ​

`isArchived` boolean
:   ​

`createdBy` string (RID)
:   The user who created the event. This field may be missing for legacy events.

`disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
:   ​

    Fields of `EventDisposition`

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
    :   ​

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate)
    :   ​

        **pendingReview**

        Set `type` to `"pendingReview"`.

        `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
        :   ​

            Fields of `PendingReviewDispositionState`

            `openedBy` string (RID)
            :   ​

        **closedWithFurtherAction**

        Set `type` to `"closedWithFurtherAction"`.

        `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
        :   ​

            Fields of `ClosedWithFurtherActionDispositionState`

            `closedBy` string (RID)
            :   ​

        **closedWithIgnore**

        Set `type` to `"closedWithIgnore"`.

        `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
        :   ​

            Fields of `ClosedWithIgnoreDispositionState`

            `closedBy` string (RID)
            :   ​

    `assignees` array of string (RID)
    :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/events/batch-filter-get" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "filterQuery": {
    "type": "archived",
    "archived": true
  }
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/events/batch-filter-get",
    headers={"Authorization": "Bearer <api key>"},
    json={"filterQuery": {"type": "archived", "archived": True}},
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/events/batch-filter-get",
    headers={"Authorization": "Bearer <api key>"},
    json={"filterQuery": {"type": "archived", "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/v1/events/batch-filter-get",
            headers={"Authorization": "Bearer <api key>"},
            json={"filterQuery": {"type": "archived", "archived": True}},
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
[
  {
    "uuid": "<uuid>",
    "rid": "<event rid>",
    "assetRids": [
      "<asset rid>"
    ],
    "origins": [
      {
        "type": "workbook",
        "workbook": {
          "rid": "<notebook rid>",
          "data": [
            {
              "type": "timeSeriesChannel",
              "timeSeriesChannel": {
                "variableName": "<variable name>",
                "tags": {
                  "<key>": "<value>"
                }
              }
            }
          ]
        }
      }
    ],
    "timestamp": {
      "seconds": 1,
      "nanos": 1
    },
    "duration": {
      "seconds": 1,
      "nanos": 1
    },
    "name": "<name>",
    "description": "<description>",
    "type": "INFO",
    "labels": [
      "<label>"
    ],
    "properties": {
      "<key>": "<property value>"
    },
    "typedProperties": {
      "<key>": {
        "type": "stringValue",
        "stringValue": "<property value>"
      }
    },
    "isArchived": true,
    "createdBy": "<user rid>",
    "disposition": {
      "priority": "P0",
      "state": {
        "type": "pendingReview",
        "pendingReview": {
          "openedBy": "<user rid>"
        }
      },
      "assignees": [
        "<user rid>"
      ]
    }
  }
]
```

### Update event

POST `/event/v1/update-event`

**Deprecated:** This endpoint is deprecated. Use the batchUpdateEvent endpoint instead.

Updates the fields of an event. Empty fields are left unchanged.

Body

`uuid` string (UUID) required deprecated
:   **Deprecated:** This field is deprecated. Use the rid field instead.

`rid` string (RID)
:   The unique identifier for the event. This field is required if the uuid field is not provided.

`assetRids` array of string (RID)
:   If provided, will replace the existing asset rids. If provided, must contain at least one asset rid.

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
:   ​

    Fields of `Timestamp`

    `seconds` integer (int64) required
    :   ​

    `nanos` integer (int64) required
    :   ​

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
:   ​

    Fields of `Duration`

    `seconds` integer (int64) required
    :   ​

    `nanos` integer (int64) required
    :   ​

`name` string
:   ​

`description` string
:   ​

`type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
:   ​

    Values of `EventType`

    `INFO`
    :   ​

    `FLAG`
    :   ​

    `ERROR`
    :   ​

    `SUCCESS`
    :   ​

`labels` array of string
:   ​

`properties` map of `PropertyName` to string deprecated
:   **Deprecated:** use typedProperties

`typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
:   ​

    **stringValue**

    Set `type` to `"stringValue"`.

    `stringValue` string
    :   ​

    **numericValue**

    Set `type` to `"numericValue"`.

    `numericValue` number
    :   ​

Response

`uuid` string (UUID) deprecated
:   **Deprecated:** This field is deprecated. Use the rid field instead.

`rid` string (RID)
:   ​

`assetRids` array of string (RID)
:   A set of asset rids associated with the event.

`origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
:   A set of origins associated with the event.

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
    :   This event was created in this workbook

        Fields of `WorkbookEventOrigin`

        `rid` string (RID)
        :   ​

        `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
        :   Data visualizations to associate this event with

            **timeSeriesChannel**

            Set `type` to `"timeSeriesChannel"`.

            `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/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**

    Set `type` to `"template"`.

    `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
    :   This event was created in this template

        Fields of `TemplateEventOrigin`

        `rid` string (RID)
        :   ​

    **api**

    Set `type` to `"api"`.

    `api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
    :   This event was created programmatically via the API

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
    :   This event was created automatically from a checklist execution.

        Fields of `DataReviewEventOrigin`

        `dataReviewRid` string (RID)
        :   ​

        `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `CheckOriginMetadata`

            `checkEvaluationRid` string (RID)
            :   ​

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
    :   This event was created automatically from a procedure execution.

        Fields of `ProcedureEventOrigin`

        `procedureExecutionRid` string (RID)
        :   ​

        `procedureRid` string (RID)
        :   ​

        `stepId` string
        :   ​

    **streamingChecklist**

    Set `type` to `"streamingChecklist"`.

    `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
    :   This event was created automatically from the execution of a streaming checklist.

        Fields of `StreamingChecklistEventOrigin`

        `checklistRid` string (RID)
        :   ​

        `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata)
        :   Metadata about the check that created this event.

            Fields of `StreamingCheckOriginMetadata`

            `checkRid` string (RID)
            :   ​

            `checkLineageRid` string (RID)
            :   ​

            `implementationIndex` integer
            :   ​

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
:   ​

    Fields of `Timestamp`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
:   ​

    Fields of `Duration`

    `seconds` integer (int64)
    :   ​

    `nanos` integer (int64)
    :   ​

`name` string
:   ​

`description` string
:   ​

`type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
:   ​

    Values of `EventType`

    `INFO`
    :   ​

    `FLAG`
    :   ​

    `ERROR`
    :   ​

    `SUCCESS`
    :   ​

`labels` array of string
:   ​

`properties` map of `PropertyName` to string deprecated
:   **Deprecated:** use typedProperties

`typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
:   ​

    **stringValue**

    Set `type` to `"stringValue"`.

    `stringValue` string
    :   ​

    **numericValue**

    Set `type` to `"numericValue"`.

    `numericValue` number
    :   ​

`isArchived` boolean
:   ​

`createdBy` string (RID)
:   The user who created the event. This field may be missing for legacy events.

`disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
:   ​

    Fields of `EventDisposition`

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
    :   ​

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate)
    :   ​

        **pendingReview**

        Set `type` to `"pendingReview"`.

        `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
        :   ​

            Fields of `PendingReviewDispositionState`

            `openedBy` string (RID)
            :   ​

        **closedWithFurtherAction**

        Set `type` to `"closedWithFurtherAction"`.

        `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
        :   ​

            Fields of `ClosedWithFurtherActionDispositionState`

            `closedBy` string (RID)
            :   ​

        **closedWithIgnore**

        Set `type` to `"closedWithIgnore"`.

        `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
        :   ​

            Fields of `ClosedWithIgnoreDispositionState`

            `closedBy` string (RID)
            :   ​

    `assignees` array of string (RID)
    :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/update-event" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "uuid": "<uuid>"
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/update-event",
    headers={"Authorization": "Bearer <api key>"},
    json={"uuid": "<uuid>"},
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/update-event",
    headers={"Authorization": "Bearer <api key>"},
    json={"uuid": "<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/v1/update-event",
            headers={"Authorization": "Bearer <api key>"},
            json={"uuid": "<uuid>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
{
  "uuid": "<uuid>",
  "rid": "<event rid>",
  "assetRids": [
    "<asset rid>"
  ],
  "origins": [
    {
      "type": "workbook",
      "workbook": {
        "rid": "<notebook rid>",
        "data": [
          {
            "type": "timeSeriesChannel",
            "timeSeriesChannel": {
              "variableName": "<variable name>",
              "tags": {
                "<key>": "<value>"
              }
            }
          }
        ]
      }
    }
  ],
  "timestamp": {
    "seconds": 1,
    "nanos": 1
  },
  "duration": {
    "seconds": 1,
    "nanos": 1
  },
  "name": "<name>",
  "description": "<description>",
  "type": "INFO",
  "labels": [
    "<label>"
  ],
  "properties": {
    "<key>": "<property value>"
  },
  "typedProperties": {
    "<key>": {
      "type": "stringValue",
      "stringValue": "<property value>"
    }
  },
  "isArchived": true,
  "createdBy": "<user rid>",
  "disposition": {
    "priority": "P0",
    "state": {
      "type": "pendingReview",
      "pendingReview": {
        "openedBy": "<user rid>"
      }
    },
    "assignees": [
      "<user rid>"
    ]
  }
}
```

### Batch update event

POST `/event/v1/events/batch-update`

Updates the fields of an event specified by each request in the batch. Empty fields in the UpdateEventRequest are left unchanged.

Body

`requests` array of [`UpdateEventRequest`](https://dev.nominal.io/api/legacy/event-service.md#updateeventrequest)
:   ​

    Fields of `UpdateEventRequest`

    `rid` string (RID) required
    :   ​

    `assetRids` array of string (RID)
    :   If provided, will replace the existing asset rids. If provided, must contain at least one asset rid.

    `timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   ​

        Fields of `Timestamp`

        `seconds` integer (int64) required
        :   ​

        `nanos` integer (int64) required
        :   ​

    `duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
    :   ​

        Fields of `Duration`

        `seconds` integer (int64) required
        :   ​

        `nanos` integer (int64) required
        :   ​

    `name` string
    :   ​

    `description` string
    :   ​

    `type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
    :   ​

        Values of `EventType`

        `INFO`
        :   ​

        `FLAG`
        :   ​

        `ERROR`
        :   ​

        `SUCCESS`
        :   ​

    `labels` array of string
    :   ​

    `properties` map of `PropertyName` to string deprecated
    :   **Deprecated:** use typedProperties

    `typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
    :   ​

        **stringValue**

        Set `type` to `"stringValue"`.

        `stringValue` string
        :   ​

        **numericValue**

        Set `type` to `"numericValue"`.

        `numericValue` number
        :   ​

Response

`events` array of [`Event`](https://dev.nominal.io/api/legacy/event-service.md#event)
:   ​

    Fields of `Event`

    `uuid` string (UUID) deprecated
    :   **Deprecated:** This field is deprecated. Use the rid field instead.

    `rid` string (RID)
    :   ​

    `assetRids` array of string (RID)
    :   A set of asset rids associated with the event.

    `origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
    :   A set of origins associated with the event.

        **workbook**

        Set `type` to `"workbook"`.

        `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
        :   This event was created in this workbook

            Fields of `WorkbookEventOrigin`

            `rid` string (RID)
            :   ​

            `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
            :   Data visualizations to associate this event with

                **timeSeriesChannel**

                Set `type` to `"timeSeriesChannel"`.

                `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/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**

        Set `type` to `"template"`.

        `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
        :   This event was created in this template

            Fields of `TemplateEventOrigin`

            `rid` string (RID)
            :   ​

        **api**

        Set `type` to `"api"`.

        `api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
        :   This event was created programmatically via the API

        **dataReview**

        Set `type` to `"dataReview"`.

        `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
        :   This event was created automatically from a checklist execution.

            Fields of `DataReviewEventOrigin`

            `dataReviewRid` string (RID)
            :   ​

            `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata)
            :   Metadata about the check that created this event.

                Fields of `CheckOriginMetadata`

                `checkEvaluationRid` string (RID)
                :   ​

                `checkRid` string (RID)
                :   ​

                `checkLineageRid` string (RID)
                :   ​

                `implementationIndex` integer
                :   ​

        **procedure**

        Set `type` to `"procedure"`.

        `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
        :   This event was created automatically from a procedure execution.

            Fields of `ProcedureEventOrigin`

            `procedureExecutionRid` string (RID)
            :   ​

            `procedureRid` string (RID)
            :   ​

            `stepId` string
            :   ​

        **streamingChecklist**

        Set `type` to `"streamingChecklist"`.

        `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
        :   This event was created automatically from the execution of a streaming checklist.

            Fields of `StreamingChecklistEventOrigin`

            `checklistRid` string (RID)
            :   ​

            `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata)
            :   Metadata about the check that created this event.

                Fields of `StreamingCheckOriginMetadata`

                `checkRid` string (RID)
                :   ​

                `checkLineageRid` string (RID)
                :   ​

                `implementationIndex` integer
                :   ​

    `timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   ​

        Fields of `Timestamp`

        `seconds` integer (int64)
        :   ​

        `nanos` integer (int64)
        :   ​

    `duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
    :   ​

        Fields of `Duration`

        `seconds` integer (int64)
        :   ​

        `nanos` integer (int64)
        :   ​

    `name` string
    :   ​

    `description` string
    :   ​

    `type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
    :   ​

        Values of `EventType`

        `INFO`
        :   ​

        `FLAG`
        :   ​

        `ERROR`
        :   ​

        `SUCCESS`
        :   ​

    `labels` array of string
    :   ​

    `properties` map of `PropertyName` to string deprecated
    :   **Deprecated:** use typedProperties

    `typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
    :   ​

        **stringValue**

        Set `type` to `"stringValue"`.

        `stringValue` string
        :   ​

        **numericValue**

        Set `type` to `"numericValue"`.

        `numericValue` number
        :   ​

    `isArchived` boolean
    :   ​

    `createdBy` string (RID)
    :   The user who created the event. This field may be missing for legacy events.

    `disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
    :   ​

        Fields of `EventDisposition`

        `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
        :   ​

            Values of `Priority`

            `P0`
            :   ​

            `P1`
            :   ​

            `P2`
            :   ​

            `P3`
            :   ​

            `P4`
            :   ​

        `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate)
        :   ​

            **pendingReview**

            Set `type` to `"pendingReview"`.

            `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
            :   ​

                Fields of `PendingReviewDispositionState`

                `openedBy` string (RID)
                :   ​

            **closedWithFurtherAction**

            Set `type` to `"closedWithFurtherAction"`.

            `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
            :   ​

                Fields of `ClosedWithFurtherActionDispositionState`

                `closedBy` string (RID)
                :   ​

            **closedWithIgnore**

            Set `type` to `"closedWithIgnore"`.

            `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
            :   ​

                Fields of `ClosedWithIgnoreDispositionState`

                `closedBy` string (RID)
                :   ​

        `assignees` array of string (RID)
        :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/events/batch-update" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "requests": [
    {
      "rid": "<event rid>"
    }
  ]
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/events/batch-update",
    headers={"Authorization": "Bearer <api key>"},
    json={"requests": [{"rid": "<event rid>"}]},
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/events/batch-update",
    headers={"Authorization": "Bearer <api key>"},
    json={"requests": [{"rid": "<event rid>"}]},
)
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/v1/events/batch-update",
            headers={"Authorization": "Bearer <api key>"},
            json={"requests": [{"rid": "<event rid>"}]},
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
{
  "events": [
    {
      "uuid": "<uuid>",
      "rid": "<event rid>",
      "assetRids": [
        "<asset rid>"
      ],
      "origins": [
        {
          "type": "workbook",
          "workbook": {
            "rid": "<notebook rid>",
            "data": [
              {
                "type": "timeSeriesChannel",
                "timeSeriesChannel": {
                  "variableName": "<variable name>",
                  "tags": {
                    "<key>": "<value>"
                  }
                }
              }
            ]
          }
        }
      ],
      "timestamp": {
        "seconds": 1,
        "nanos": 1
      },
      "duration": {
        "seconds": 1,
        "nanos": 1
      },
      "name": "<name>",
      "description": "<description>",
      "type": "INFO",
      "labels": [
        "<label>"
      ],
      "properties": {
        "<key>": "<property value>"
      },
      "typedProperties": {
        "<key>": {
          "type": "stringValue",
          "stringValue": "<property value>"
        }
      },
      "isArchived": true,
      "createdBy": "<user rid>",
      "disposition": {
        "priority": "P0",
        "state": {
          "type": "pendingReview",
          "pendingReview": {
            "openedBy": "<user rid>"
          }
        },
        "assignees": [
          "<user rid>"
        ]
      }
    }
  ]
}
```

### Batch update disposition

POST `/event/v1/update-disposition`

Updates the disposition of an event.

Body

`requests` array of [`UpdateDispositionRequest`](https://dev.nominal.io/api/legacy/event-service.md#updatedispositionrequest)
:   ​

    Fields of `UpdateDispositionRequest`

    `rid` string (RID) required
    :   ​

    `disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
    :   The new disposition for the event. If empty, will remove the disposition from the event.

        Fields of `EventDisposition`

        `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority) required
        :   ​

            Values of `Priority`

            `P0`
            :   ​

            `P1`
            :   ​

            `P2`
            :   ​

            `P3`
            :   ​

            `P4`
            :   ​

        `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate) required
        :   ​

            **pendingReview**

            Set `type` to `"pendingReview"`.

            `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
            :   ​

                Fields of `PendingReviewDispositionState`

                `openedBy` string (RID) required
                :   ​

            **closedWithFurtherAction**

            Set `type` to `"closedWithFurtherAction"`.

            `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
            :   ​

                Fields of `ClosedWithFurtherActionDispositionState`

                `closedBy` string (RID) required
                :   ​

            **closedWithIgnore**

            Set `type` to `"closedWithIgnore"`.

            `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
            :   ​

                Fields of `ClosedWithIgnoreDispositionState`

                `closedBy` string (RID) required
                :   ​

        `assignees` array of string (RID)
        :   ​

Response

`events` array of [`Event`](https://dev.nominal.io/api/legacy/event-service.md#event)
:   ​

    Fields of `Event`

    `uuid` string (UUID) deprecated
    :   **Deprecated:** This field is deprecated. Use the rid field instead.

    `rid` string (RID)
    :   ​

    `assetRids` array of string (RID)
    :   A set of asset rids associated with the event.

    `origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
    :   A set of origins associated with the event.

        **workbook**

        Set `type` to `"workbook"`.

        `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
        :   This event was created in this workbook

            Fields of `WorkbookEventOrigin`

            `rid` string (RID)
            :   ​

            `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
            :   Data visualizations to associate this event with

                **timeSeriesChannel**

                Set `type` to `"timeSeriesChannel"`.

                `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/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**

        Set `type` to `"template"`.

        `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
        :   This event was created in this template

            Fields of `TemplateEventOrigin`

            `rid` string (RID)
            :   ​

        **api**

        Set `type` to `"api"`.

        `api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
        :   This event was created programmatically via the API

        **dataReview**

        Set `type` to `"dataReview"`.

        `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
        :   This event was created automatically from a checklist execution.

            Fields of `DataReviewEventOrigin`

            `dataReviewRid` string (RID)
            :   ​

            `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata)
            :   Metadata about the check that created this event.

                Fields of `CheckOriginMetadata`

                `checkEvaluationRid` string (RID)
                :   ​

                `checkRid` string (RID)
                :   ​

                `checkLineageRid` string (RID)
                :   ​

                `implementationIndex` integer
                :   ​

        **procedure**

        Set `type` to `"procedure"`.

        `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
        :   This event was created automatically from a procedure execution.

            Fields of `ProcedureEventOrigin`

            `procedureExecutionRid` string (RID)
            :   ​

            `procedureRid` string (RID)
            :   ​

            `stepId` string
            :   ​

        **streamingChecklist**

        Set `type` to `"streamingChecklist"`.

        `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
        :   This event was created automatically from the execution of a streaming checklist.

            Fields of `StreamingChecklistEventOrigin`

            `checklistRid` string (RID)
            :   ​

            `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata)
            :   Metadata about the check that created this event.

                Fields of `StreamingCheckOriginMetadata`

                `checkRid` string (RID)
                :   ​

                `checkLineageRid` string (RID)
                :   ​

                `implementationIndex` integer
                :   ​

    `timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   ​

        Fields of `Timestamp`

        `seconds` integer (int64)
        :   ​

        `nanos` integer (int64)
        :   ​

    `duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
    :   ​

        Fields of `Duration`

        `seconds` integer (int64)
        :   ​

        `nanos` integer (int64)
        :   ​

    `name` string
    :   ​

    `description` string
    :   ​

    `type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
    :   ​

        Values of `EventType`

        `INFO`
        :   ​

        `FLAG`
        :   ​

        `ERROR`
        :   ​

        `SUCCESS`
        :   ​

    `labels` array of string
    :   ​

    `properties` map of `PropertyName` to string deprecated
    :   **Deprecated:** use typedProperties

    `typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
    :   ​

        **stringValue**

        Set `type` to `"stringValue"`.

        `stringValue` string
        :   ​

        **numericValue**

        Set `type` to `"numericValue"`.

        `numericValue` number
        :   ​

    `isArchived` boolean
    :   ​

    `createdBy` string (RID)
    :   The user who created the event. This field may be missing for legacy events.

    `disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
    :   ​

        Fields of `EventDisposition`

        `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
        :   ​

            Values of `Priority`

            `P0`
            :   ​

            `P1`
            :   ​

            `P2`
            :   ​

            `P3`
            :   ​

            `P4`
            :   ​

        `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate)
        :   ​

            **pendingReview**

            Set `type` to `"pendingReview"`.

            `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
            :   ​

                Fields of `PendingReviewDispositionState`

                `openedBy` string (RID)
                :   ​

            **closedWithFurtherAction**

            Set `type` to `"closedWithFurtherAction"`.

            `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
            :   ​

                Fields of `ClosedWithFurtherActionDispositionState`

                `closedBy` string (RID)
                :   ​

            **closedWithIgnore**

            Set `type` to `"closedWithIgnore"`.

            `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
            :   ​

                Fields of `ClosedWithIgnoreDispositionState`

                `closedBy` string (RID)
                :   ​

        `assignees` array of string (RID)
        :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/update-disposition" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "requests": [
    {
      "rid": "<event rid>"
    }
  ]
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/update-disposition",
    headers={"Authorization": "Bearer <api key>"},
    json={"requests": [{"rid": "<event rid>"}]},
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/update-disposition",
    headers={"Authorization": "Bearer <api key>"},
    json={"requests": [{"rid": "<event rid>"}]},
)
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/v1/update-disposition",
            headers={"Authorization": "Bearer <api key>"},
            json={"requests": [{"rid": "<event rid>"}]},
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
{
  "events": [
    {
      "uuid": "<uuid>",
      "rid": "<event rid>",
      "assetRids": [
        "<asset rid>"
      ],
      "origins": [
        {
          "type": "workbook",
          "workbook": {
            "rid": "<notebook rid>",
            "data": [
              {
                "type": "timeSeriesChannel",
                "timeSeriesChannel": {
                  "variableName": "<variable name>",
                  "tags": {
                    "<key>": "<value>"
                  }
                }
              }
            ]
          }
        }
      ],
      "timestamp": {
        "seconds": 1,
        "nanos": 1
      },
      "duration": {
        "seconds": 1,
        "nanos": 1
      },
      "name": "<name>",
      "description": "<description>",
      "type": "INFO",
      "labels": [
        "<label>"
      ],
      "properties": {
        "<key>": "<property value>"
      },
      "typedProperties": {
        "<key>": {
          "type": "stringValue",
          "stringValue": "<property value>"
        }
      },
      "isArchived": true,
      "createdBy": "<user rid>",
      "disposition": {
        "priority": "P0",
        "state": {
          "type": "pendingReview",
          "pendingReview": {
            "openedBy": "<user rid>"
          }
        },
        "assignees": [
          "<user rid>"
        ]
      }
    }
  ]
}
```

### Archive event

POST `/event/v1/archive-event`

**Deprecated:** This endpoint is deprecated. Use the batchArchiveEvents endpoint instead.

Archives an event

Body

`uuid` string (UUID) required
:   ​

Response

No content (HTTP 204).

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/archive-event" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "uuid": "<uuid>"
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/archive-event",
    headers={"Authorization": "Bearer <api key>"},
    json={"uuid": "<uuid>"},
)
response.raise_for_status()
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/archive-event",
    headers={"Authorization": "Bearer <api key>"},
    json={"uuid": "<uuid>"},
)
response.raise_for_status()
```

**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/v1/archive-event",
            headers={"Authorization": "Bearer <api key>"},
            json={"uuid": "<uuid>"},
        ) as response:
            response.raise_for_status()

asyncio.run(main())
```

Response: `204`

No content.

### Batch archive event

POST `/event/v1/batch-archive-events`

Archives a set of events

Body

The body is an array of string (RID).

Response

No content (HTTP 204).

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/batch-archive-events" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '[
  "<event rid>"
]'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/batch-archive-events",
    headers={"Authorization": "Bearer <api key>"},
    json=["<event rid>"],
)
response.raise_for_status()
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/batch-archive-events",
    headers={"Authorization": "Bearer <api key>"},
    json=["<event rid>"],
)
response.raise_for_status()
```

**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/v1/batch-archive-events",
            headers={"Authorization": "Bearer <api key>"},
            json=["<event rid>"],
        ) as response:
            response.raise_for_status()

asyncio.run(main())
```

Response: `204`

No content.

### Batch unarchive event

POST `/event/v1/batch-unarchive-events`

Unarchives a set of events

Body

The body is an array of string (RID).

Response

No content (HTTP 204).

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/batch-unarchive-events" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '[
  "<event rid>"
]'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/batch-unarchive-events",
    headers={"Authorization": "Bearer <api key>"},
    json=["<event rid>"],
)
response.raise_for_status()
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/batch-unarchive-events",
    headers={"Authorization": "Bearer <api key>"},
    json=["<event rid>"],
)
response.raise_for_status()
```

**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/v1/batch-unarchive-events",
            headers={"Authorization": "Bearer <api key>"},
            json=["<event rid>"],
        ) as response:
            response.raise_for_status()

asyncio.run(main())
```

Response: `204`

No content.

### Search events

POST `/event/v1/search-events`

Searches for events that match the given filters.

Body

`sort` [`SortOptions`](https://dev.nominal.io/api/legacy/event-service.md#sortoptions) required
:   ​

    Fields of `SortOptions`

    `isDescending` boolean required
    :   ​

    `field` [`SortField`](https://dev.nominal.io/api/legacy/event-service.md#sortfield) required
    :   ​

        Values of `SortField`

        `START_TIME`
        :   ​

        `END_TIME`
        :   ​

        `DURATION`
        :   ​

        `DISPOSITION_STATUS`
        :   ​

        `PRIORITY`
        :   ​

        `EVENT_NAME`
        :   ​

`pageSize` integer required
:   Will reject page sizes greater than 10k.

`nextPageToken` string
:   ​

`query` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery) required
:   ​

    **archived**

    Set `type` to `"archived"`.

    `archived` boolean
    :   ​

    **searchText**

    Set `type` to `"searchText"`.

    `searchText` string
    :   Search text to perform fuzzy searching against.

    **exactMatch**

    Set `type` to `"exactMatch"`.

    `exactMatch` string
    :   Search text to perform exact matching against on the event name and description.

    **after**

    Set `type` to `"after"`.

    `after` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   Filters to events after this timestamp, exclusive. This includes events that start before, but end after this time.

        Fields of `Timestamp`

        `seconds` integer (int64) required
        :   ​

        `nanos` integer (int64) required
        :   ​

    **before**

    Set `type` to `"before"`.

    `before` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   Filters to events before this timestamp, exclusive. This includes events that start before, but end after this time.

    **advancedTimeFilter**

    Set `type` to `"advancedTimeFilter"`.

    `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefilter)
    :   ​

        Fields of `EventTimeFilter`

        `timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
        :   ​

        `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefiltercondition) required
        :   ​

            Values of `EventTimeFilterCondition`

            `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**

    Set `type` to `"asset"`.

    `asset` string (RID) deprecated
    :   **Deprecated:** use assetRids

    **assets**

    Set `type` to `"assets"`.

    `assets` [`AssetsFilter`](https://dev.nominal.io/api/legacy/event-service.md#assetsfilter)
    :   ​

        Fields of `AssetsFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

            Values of `SetOperator`

            `AND`
            :   ​

            `OR`
            :   ​

        `assets` array of string (RID)
        :   ​

    **template**

    Set `type` to `"template"`.

    `template` string (RID)
    :   ​

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` string (RID)
    :   ​

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` string (RID) deprecated
    :   **Deprecated:** use dataReviews instead

    **dataReviews**

    Set `type` to `"dataReviews"`.

    `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewsfilter)
    :   ​

        Fields of `DataReviewsFilter`

        `dataReviews` array of string (RID)
        :   ​

    **originType**

    Set `type` to `"originType"`.

    `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype) deprecated
    :   **Deprecated:** use originTypes instead

        Values of `SearchEventOriginType`

        `WORKBOOK`
        :   ​

        `TEMPLATE`
        :   ​

        `API`
        :   ​

        `DATA_REVIEW`
        :   ​

        `PROCEDURE`
        :   ​

        `STREAMING_CHECKLIST`
        :   ​

    **originTypes**

    Set `type` to `"originTypes"`.

    `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/legacy/event-service.md#origintypesfilter)
    :   ​

        Fields of `OriginTypesFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

        `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype)
        :   ​

    **dataReviewCheck**

    Set `type` to `"dataReviewCheck"`.

    `dataReviewCheck` string (RID) deprecated
    :   **Deprecated:** use dataReviewChecks instead

    **dataReviewChecks**

    Set `type` to `"dataReviewChecks"`.

    `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewchecksfilter)
    :   ​

        Fields of `DataReviewChecksFilter`

        `dataReviewChecks` array of string (RID)
        :   ​

    **dispositionStatus**

    Set `type` to `"dispositionStatus"`.

    `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus) deprecated
    :   **Deprecated:** use dispositionStatuses instead

        Values of `EventDispositionStatus`

        `PENDING_REVIEW`
        :   ​

        `CLOSED_IGNORED`
        :   ​

        `CLOSED_REQUIRES_FURTHER_ACTION`
        :   ​

        `NO_DISPOSITION`
        :   ​

    **dispositionStatuses**

    Set `type` to `"dispositionStatuses"`.

    `dispositionStatuses` array of [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus)
    :   ​

    **priority**

    Set `type` to `"priority"`.

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority) deprecated
    :   **Deprecated:** use priorities instead

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    **priorities**

    Set `type` to `"priorities"`.

    `priorities` array of [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
    :   ​

    **assignee**

    Set `type` to `"assignee"`.

    `assignee` string (RID) deprecated
    :   **Deprecated:** use assignees instead

    **assignees**

    Set `type` to `"assignees"`.

    `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/legacy/event-service.md#assigneesfilter)
    :   ​

        Fields of `AssigneesFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

        `assignees` array of string (RID)
        :   ​

    **eventType**

    Set `type` to `"eventType"`.

    `eventType` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype) deprecated
    :   **Deprecated:** use eventTypes instead

        Values of `EventType`

        `INFO`
        :   ​

        `FLAG`
        :   ​

        `ERROR`
        :   ​

        `SUCCESS`
        :   ​

    **eventTypes**

    Set `type` to `"eventTypes"`.

    `eventTypes` array of [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
    :   ​

    **createdBy**

    Set `type` to `"createdBy"`.

    `createdBy` string (RID)
    :   ​

    **createdByAnyOf**

    Set `type` to `"createdByAnyOf"`.

    `createdByAnyOf` array of string (RID)
    :   ​

    **label**

    Set `type` to `"label"`.

    `label` string deprecated
    :   **Deprecated:** use labels instead

    **labels**

    Set `type` to `"labels"`.

    `labels` [`LabelsFilter`](https://dev.nominal.io/api/legacy/event-service.md#labelsfilter)
    :   ​

        Fields of `LabelsFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

        `labels` array of string
        :   ​

    **property**

    Set `type` to `"property"`.

    `property` [`Property`](https://dev.nominal.io/api/legacy/event-service.md#property) deprecated
    :   **Deprecated:** use properties instead

        Fields of `Property`

        `name` string required
        :   ​

        `value` string required
        :   ​

    **properties**

    Set `type` to `"properties"`.

    `properties` [`PropertiesFilter`](https://dev.nominal.io/api/legacy/event-service.md#propertiesfilter)
    :   ​

        Fields of `PropertiesFilter`

        `name` string required
        :   ​

        `values` array of string
        :   ​

    **and**

    Set `type` to `"and"`.

    `and` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
    :   ​

    **or**

    Set `type` to `"or"`.

    `or` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
    :   ​

    **not**

    Set `type` to `"not"`.

    `not` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
    :   ​

    **workspace**

    Set `type` to `"workspace"`.

    `workspace` string (RID)
    :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` string (RID)
    :   ​

    **procedureExecution**

    Set `type` to `"procedureExecution"`.

    `procedureExecution` string (RID)
    :   ​

    **stepId**

    Set `type` to `"stepId"`.

    `stepId` string
    :   ​

    **streamingChecklist**

    Set `type` to `"streamingChecklist"`.

    `streamingChecklist` string (RID)
    :   Filters to events created from a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

    **streamingCheck**

    Set `type` to `"streamingCheck"`.

    `streamingCheck` string (RID)
    :   Filters to events created from the check of a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

    **numericProperty**

    Set `type` to `"numericProperty"`.

    `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertypredicate)
    :   Matches events using a numeric property comparison.

        Fields of `NumericPropertyPredicate`

        `name` string required
        :   ​

        `value` number required
        :   ​

        `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/legacy/event-service.md#propertycomparisonoperator) required
        :   ​

            Values of `PropertyComparisonOperator`

            `EQ`
            :   ​

            `NEQ`
            :   ​

            `GT`
            :   ​

            `GTE`
            :   ​

            `LT`
            :   ​

            `LTE`
            :   ​

    **numericPropertyRange**

    Set `type` to `"numericPropertyRange"`.

    `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangepredicate)
    :   Matches events using an inclusive numeric property range.

        Fields of `NumericPropertyRangePredicate`

        `name` string required
        :   ​

        `min` number
        :   ​

        `max` number
        :   ​

        `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangeoperator) required
        :   ​

            Values of `NumericPropertyRangeOperator`

            `BETWEEN`
            :   ​

            `NOT_BETWEEN`
            :   ​

`archivedStatuses` array of [`ArchivedStatus`](https://dev.nominal.io/api/legacy/event-service.md#archivedstatus)
:   Default search status is NOT_ARCHIVED if none are provided. Allows for including archived events in search.

    Values of `ArchivedStatus`

    `NOT_ARCHIVED`
    :   ​

    `ARCHIVED`
    :   ​

Response

`results` array of [`Event`](https://dev.nominal.io/api/legacy/event-service.md#event)
:   ​

    Fields of `Event`

    `uuid` string (UUID) deprecated
    :   **Deprecated:** This field is deprecated. Use the rid field instead.

    `rid` string (RID)
    :   ​

    `assetRids` array of string (RID)
    :   A set of asset rids associated with the event.

    `origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
    :   A set of origins associated with the event.

        **workbook**

        Set `type` to `"workbook"`.

        `workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
        :   This event was created in this workbook

            Fields of `WorkbookEventOrigin`

            `rid` string (RID)
            :   ​

            `data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
            :   Data visualizations to associate this event with

                **timeSeriesChannel**

                Set `type` to `"timeSeriesChannel"`.

                `timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/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**

        Set `type` to `"template"`.

        `template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
        :   This event was created in this template

            Fields of `TemplateEventOrigin`

            `rid` string (RID)
            :   ​

        **api**

        Set `type` to `"api"`.

        `api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
        :   This event was created programmatically via the API

        **dataReview**

        Set `type` to `"dataReview"`.

        `dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
        :   This event was created automatically from a checklist execution.

            Fields of `DataReviewEventOrigin`

            `dataReviewRid` string (RID)
            :   ​

            `checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata)
            :   Metadata about the check that created this event.

                Fields of `CheckOriginMetadata`

                `checkEvaluationRid` string (RID)
                :   ​

                `checkRid` string (RID)
                :   ​

                `checkLineageRid` string (RID)
                :   ​

                `implementationIndex` integer
                :   ​

        **procedure**

        Set `type` to `"procedure"`.

        `procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
        :   This event was created automatically from a procedure execution.

            Fields of `ProcedureEventOrigin`

            `procedureExecutionRid` string (RID)
            :   ​

            `procedureRid` string (RID)
            :   ​

            `stepId` string
            :   ​

        **streamingChecklist**

        Set `type` to `"streamingChecklist"`.

        `streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
        :   This event was created automatically from the execution of a streaming checklist.

            Fields of `StreamingChecklistEventOrigin`

            `checklistRid` string (RID)
            :   ​

            `checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata)
            :   Metadata about the check that created this event.

                Fields of `StreamingCheckOriginMetadata`

                `checkRid` string (RID)
                :   ​

                `checkLineageRid` string (RID)
                :   ​

                `implementationIndex` integer
                :   ​

    `timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   ​

        Fields of `Timestamp`

        `seconds` integer (int64)
        :   ​

        `nanos` integer (int64)
        :   ​

    `duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
    :   ​

        Fields of `Duration`

        `seconds` integer (int64)
        :   ​

        `nanos` integer (int64)
        :   ​

    `name` string
    :   ​

    `description` string
    :   ​

    `type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
    :   ​

        Values of `EventType`

        `INFO`
        :   ​

        `FLAG`
        :   ​

        `ERROR`
        :   ​

        `SUCCESS`
        :   ​

    `labels` array of string
    :   ​

    `properties` map of `PropertyName` to string deprecated
    :   **Deprecated:** use typedProperties

    `typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
    :   ​

        **stringValue**

        Set `type` to `"stringValue"`.

        `stringValue` string
        :   ​

        **numericValue**

        Set `type` to `"numericValue"`.

        `numericValue` number
        :   ​

    `isArchived` boolean
    :   ​

    `createdBy` string (RID)
    :   The user who created the event. This field may be missing for legacy events.

    `disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
    :   ​

        Fields of `EventDisposition`

        `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
        :   ​

            Values of `Priority`

            `P0`
            :   ​

            `P1`
            :   ​

            `P2`
            :   ​

            `P3`
            :   ​

            `P4`
            :   ​

        `state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate)
        :   ​

            **pendingReview**

            Set `type` to `"pendingReview"`.

            `pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
            :   ​

                Fields of `PendingReviewDispositionState`

                `openedBy` string (RID)
                :   ​

            **closedWithFurtherAction**

            Set `type` to `"closedWithFurtherAction"`.

            `closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
            :   ​

                Fields of `ClosedWithFurtherActionDispositionState`

                `closedBy` string (RID)
                :   ​

            **closedWithIgnore**

            Set `type` to `"closedWithIgnore"`.

            `closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
            :   ​

                Fields of `ClosedWithIgnoreDispositionState`

                `closedBy` string (RID)
                :   ​

        `assignees` array of string (RID)
        :   ​

`nextPageToken` string
:   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/search-events" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "sort": {
    "isDescending": true,
    "field": "START_TIME"
  },
  "pageSize": 1,
  "query": {
    "type": "archived",
    "archived": true
  }
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/search-events",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "sort": {"isDescending": True, "field": "START_TIME"},
        "pageSize": 1,
        "query": {"type": "archived", "archived": True},
    },
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/search-events",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "sort": {"isDescending": True, "field": "START_TIME"},
        "pageSize": 1,
        "query": {"type": "archived", "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/v1/search-events",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "sort": {"isDescending": True, "field": "START_TIME"},
                "pageSize": 1,
                "query": {"type": "archived", "archived": True},
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
{
  "results": [
    {
      "uuid": "<uuid>",
      "rid": "<event rid>",
      "assetRids": [
        "<asset rid>"
      ],
      "origins": [
        {
          "type": "workbook",
          "workbook": {
            "rid": "<notebook rid>",
            "data": [
              {
                "type": "timeSeriesChannel",
                "timeSeriesChannel": {
                  "variableName": "<variable name>",
                  "tags": {
                    "<key>": "<value>"
                  }
                }
              }
            ]
          }
        }
      ],
      "timestamp": {
        "seconds": 1,
        "nanos": 1
      },
      "duration": {
        "seconds": 1,
        "nanos": 1
      },
      "name": "<name>",
      "description": "<description>",
      "type": "INFO",
      "labels": [
        "<label>"
      ],
      "properties": {
        "<key>": "<property value>"
      },
      "typedProperties": {
        "<key>": {
          "type": "stringValue",
          "stringValue": "<property value>"
        }
      },
      "isArchived": true,
      "createdBy": "<user rid>",
      "disposition": {
        "priority": "P0",
        "state": {
          "type": "pendingReview",
          "pendingReview": {
            "openedBy": "<user rid>"
          }
        },
        "assignees": [
          "<user rid>"
        ]
      }
    }
  ],
  "nextPageToken": "<token>"
}
```

### Aggregate events

POST `/event/v1/aggregate-events`

Searches for events matching the given filter and aggregates them based on the requested functions.

Body

`query` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery) required
:   ​

    **archived**

    Set `type` to `"archived"`.

    `archived` boolean
    :   ​

    **searchText**

    Set `type` to `"searchText"`.

    `searchText` string
    :   Search text to perform fuzzy searching against.

    **exactMatch**

    Set `type` to `"exactMatch"`.

    `exactMatch` string
    :   Search text to perform exact matching against on the event name and description.

    **after**

    Set `type` to `"after"`.

    `after` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   Filters to events after this timestamp, exclusive. This includes events that start before, but end after this time.

        Fields of `Timestamp`

        `seconds` integer (int64) required
        :   ​

        `nanos` integer (int64) required
        :   ​

    **before**

    Set `type` to `"before"`.

    `before` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   Filters to events before this timestamp, exclusive. This includes events that start before, but end after this time.

    **advancedTimeFilter**

    Set `type` to `"advancedTimeFilter"`.

    `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefilter)
    :   ​

        Fields of `EventTimeFilter`

        `timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
        :   ​

        `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefiltercondition) required
        :   ​

            Values of `EventTimeFilterCondition`

            `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**

    Set `type` to `"asset"`.

    `asset` string (RID) deprecated
    :   **Deprecated:** use assetRids

    **assets**

    Set `type` to `"assets"`.

    `assets` [`AssetsFilter`](https://dev.nominal.io/api/legacy/event-service.md#assetsfilter)
    :   ​

        Fields of `AssetsFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

            Values of `SetOperator`

            `AND`
            :   ​

            `OR`
            :   ​

        `assets` array of string (RID)
        :   ​

    **template**

    Set `type` to `"template"`.

    `template` string (RID)
    :   ​

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` string (RID)
    :   ​

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` string (RID) deprecated
    :   **Deprecated:** use dataReviews instead

    **dataReviews**

    Set `type` to `"dataReviews"`.

    `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewsfilter)
    :   ​

        Fields of `DataReviewsFilter`

        `dataReviews` array of string (RID)
        :   ​

    **originType**

    Set `type` to `"originType"`.

    `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype) deprecated
    :   **Deprecated:** use originTypes instead

        Values of `SearchEventOriginType`

        `WORKBOOK`
        :   ​

        `TEMPLATE`
        :   ​

        `API`
        :   ​

        `DATA_REVIEW`
        :   ​

        `PROCEDURE`
        :   ​

        `STREAMING_CHECKLIST`
        :   ​

    **originTypes**

    Set `type` to `"originTypes"`.

    `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/legacy/event-service.md#origintypesfilter)
    :   ​

        Fields of `OriginTypesFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

        `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype)
        :   ​

    **dataReviewCheck**

    Set `type` to `"dataReviewCheck"`.

    `dataReviewCheck` string (RID) deprecated
    :   **Deprecated:** use dataReviewChecks instead

    **dataReviewChecks**

    Set `type` to `"dataReviewChecks"`.

    `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewchecksfilter)
    :   ​

        Fields of `DataReviewChecksFilter`

        `dataReviewChecks` array of string (RID)
        :   ​

    **dispositionStatus**

    Set `type` to `"dispositionStatus"`.

    `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus) deprecated
    :   **Deprecated:** use dispositionStatuses instead

        Values of `EventDispositionStatus`

        `PENDING_REVIEW`
        :   ​

        `CLOSED_IGNORED`
        :   ​

        `CLOSED_REQUIRES_FURTHER_ACTION`
        :   ​

        `NO_DISPOSITION`
        :   ​

    **dispositionStatuses**

    Set `type` to `"dispositionStatuses"`.

    `dispositionStatuses` array of [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus)
    :   ​

    **priority**

    Set `type` to `"priority"`.

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority) deprecated
    :   **Deprecated:** use priorities instead

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    **priorities**

    Set `type` to `"priorities"`.

    `priorities` array of [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
    :   ​

    **assignee**

    Set `type` to `"assignee"`.

    `assignee` string (RID) deprecated
    :   **Deprecated:** use assignees instead

    **assignees**

    Set `type` to `"assignees"`.

    `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/legacy/event-service.md#assigneesfilter)
    :   ​

        Fields of `AssigneesFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

        `assignees` array of string (RID)
        :   ​

    **eventType**

    Set `type` to `"eventType"`.

    `eventType` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype) deprecated
    :   **Deprecated:** use eventTypes instead

        Values of `EventType`

        `INFO`
        :   ​

        `FLAG`
        :   ​

        `ERROR`
        :   ​

        `SUCCESS`
        :   ​

    **eventTypes**

    Set `type` to `"eventTypes"`.

    `eventTypes` array of [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
    :   ​

    **createdBy**

    Set `type` to `"createdBy"`.

    `createdBy` string (RID)
    :   ​

    **createdByAnyOf**

    Set `type` to `"createdByAnyOf"`.

    `createdByAnyOf` array of string (RID)
    :   ​

    **label**

    Set `type` to `"label"`.

    `label` string deprecated
    :   **Deprecated:** use labels instead

    **labels**

    Set `type` to `"labels"`.

    `labels` [`LabelsFilter`](https://dev.nominal.io/api/legacy/event-service.md#labelsfilter)
    :   ​

        Fields of `LabelsFilter`

        `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
        :   ​

        `labels` array of string
        :   ​

    **property**

    Set `type` to `"property"`.

    `property` [`Property`](https://dev.nominal.io/api/legacy/event-service.md#property) deprecated
    :   **Deprecated:** use properties instead

        Fields of `Property`

        `name` string required
        :   ​

        `value` string required
        :   ​

    **properties**

    Set `type` to `"properties"`.

    `properties` [`PropertiesFilter`](https://dev.nominal.io/api/legacy/event-service.md#propertiesfilter)
    :   ​

        Fields of `PropertiesFilter`

        `name` string required
        :   ​

        `values` array of string
        :   ​

    **and**

    Set `type` to `"and"`.

    `and` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
    :   ​

    **or**

    Set `type` to `"or"`.

    `or` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
    :   ​

    **not**

    Set `type` to `"not"`.

    `not` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
    :   ​

    **workspace**

    Set `type` to `"workspace"`.

    `workspace` string (RID)
    :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` string (RID)
    :   ​

    **procedureExecution**

    Set `type` to `"procedureExecution"`.

    `procedureExecution` string (RID)
    :   ​

    **stepId**

    Set `type` to `"stepId"`.

    `stepId` string
    :   ​

    **streamingChecklist**

    Set `type` to `"streamingChecklist"`.

    `streamingChecklist` string (RID)
    :   Filters to events created from a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

    **streamingCheck**

    Set `type` to `"streamingCheck"`.

    `streamingCheck` string (RID)
    :   Filters to events created from the check of a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

    **numericProperty**

    Set `type` to `"numericProperty"`.

    `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertypredicate)
    :   Matches events using a numeric property comparison.

        Fields of `NumericPropertyPredicate`

        `name` string required
        :   ​

        `value` number required
        :   ​

        `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/legacy/event-service.md#propertycomparisonoperator) required
        :   ​

            Values of `PropertyComparisonOperator`

            `EQ`
            :   ​

            `NEQ`
            :   ​

            `GT`
            :   ​

            `GTE`
            :   ​

            `LT`
            :   ​

            `LTE`
            :   ​

    **numericPropertyRange**

    Set `type` to `"numericPropertyRange"`.

    `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangepredicate)
    :   Matches events using an inclusive numeric property range.

        Fields of `NumericPropertyRangePredicate`

        `name` string required
        :   ​

        `min` number
        :   ​

        `max` number
        :   ​

        `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangeoperator) required
        :   ​

            Values of `NumericPropertyRangeOperator`

            `BETWEEN`
            :   ​

            `NOT_BETWEEN`
            :   ​

`aggregateTypes` array of [`AggregateType`](https://dev.nominal.io/api/legacy/event-service.md#aggregatetype)
:   ​

    Values of `AggregateType`

    `TOTAL_DURATION`
    :   ​

    `TOTAL_COUNT`
    :   ​

Response

`values` map of string to [`AggregateValue`](https://dev.nominal.io/api/legacy/event-service.md#aggregatevalue)
:   ​

    **duration**

    Set `type` to `"duration"`.

    `duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
    :   ​

        Fields of `Duration`

        `seconds` integer (int64)
        :   ​

        `nanos` integer (int64)
        :   ​

    **count**

    Set `type` to `"count"`.

    `count` integer
    :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/aggregate-events" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "query": {
    "type": "archived",
    "archived": true
  }
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/aggregate-events",
    headers={"Authorization": "Bearer <api key>"},
    json={"query": {"type": "archived", "archived": True}},
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/aggregate-events",
    headers={"Authorization": "Bearer <api key>"},
    json={"query": {"type": "archived", "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/v1/aggregate-events",
            headers={"Authorization": "Bearer <api key>"},
            json={"query": {"type": "archived", "archived": True}},
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
{
  "values": {
    "<key>": {
      "type": "duration",
      "duration": {
        "seconds": 1,
        "nanos": 1
      }
    }
  }
}
```

### Batch aggregate events

POST `/event/v1/aggregate-events/batch`

Searches for events matching the given filter and aggregates them based on the requested functions. Returns a list of responses in same order as the batched requests.

Body

`requests` array of [`AggregateEventsRequest`](https://dev.nominal.io/api/legacy/event-service.md#aggregateeventsrequest)
:   ​

    Fields of `AggregateEventsRequest`

    `query` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery) required
    :   ​

        **archived**

        Set `type` to `"archived"`.

        `archived` boolean
        :   ​

        **searchText**

        Set `type` to `"searchText"`.

        `searchText` string
        :   Search text to perform fuzzy searching against.

        **exactMatch**

        Set `type` to `"exactMatch"`.

        `exactMatch` string
        :   Search text to perform exact matching against on the event name and description.

        **after**

        Set `type` to `"after"`.

        `after` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
        :   Filters to events after this timestamp, exclusive. This includes events that start before, but end after this time.

            Fields of `Timestamp`

            `seconds` integer (int64) required
            :   ​

            `nanos` integer (int64) required
            :   ​

        **before**

        Set `type` to `"before"`.

        `before` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
        :   Filters to events before this timestamp, exclusive. This includes events that start before, but end after this time.

        **advancedTimeFilter**

        Set `type` to `"advancedTimeFilter"`.

        `advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefilter)
        :   ​

            Fields of `EventTimeFilter`

            `timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
            :   ​

            `timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefiltercondition) required
            :   ​

                Values of `EventTimeFilterCondition`

                `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**

        Set `type` to `"asset"`.

        `asset` string (RID) deprecated
        :   **Deprecated:** use assetRids

        **assets**

        Set `type` to `"assets"`.

        `assets` [`AssetsFilter`](https://dev.nominal.io/api/legacy/event-service.md#assetsfilter)
        :   ​

            Fields of `AssetsFilter`

            `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
            :   ​

                Values of `SetOperator`

                `AND`
                :   ​

                `OR`
                :   ​

            `assets` array of string (RID)
            :   ​

        **template**

        Set `type` to `"template"`.

        `template` string (RID)
        :   ​

        **workbook**

        Set `type` to `"workbook"`.

        `workbook` string (RID)
        :   ​

        **dataReview**

        Set `type` to `"dataReview"`.

        `dataReview` string (RID) deprecated
        :   **Deprecated:** use dataReviews instead

        **dataReviews**

        Set `type` to `"dataReviews"`.

        `dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewsfilter)
        :   ​

            Fields of `DataReviewsFilter`

            `dataReviews` array of string (RID)
            :   ​

        **originType**

        Set `type` to `"originType"`.

        `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype) deprecated
        :   **Deprecated:** use originTypes instead

            Values of `SearchEventOriginType`

            `WORKBOOK`
            :   ​

            `TEMPLATE`
            :   ​

            `API`
            :   ​

            `DATA_REVIEW`
            :   ​

            `PROCEDURE`
            :   ​

            `STREAMING_CHECKLIST`
            :   ​

        **originTypes**

        Set `type` to `"originTypes"`.

        `originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/legacy/event-service.md#origintypesfilter)
        :   ​

            Fields of `OriginTypesFilter`

            `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
            :   ​

            `originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype)
            :   ​

        **dataReviewCheck**

        Set `type` to `"dataReviewCheck"`.

        `dataReviewCheck` string (RID) deprecated
        :   **Deprecated:** use dataReviewChecks instead

        **dataReviewChecks**

        Set `type` to `"dataReviewChecks"`.

        `dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewchecksfilter)
        :   ​

            Fields of `DataReviewChecksFilter`

            `dataReviewChecks` array of string (RID)
            :   ​

        **dispositionStatus**

        Set `type` to `"dispositionStatus"`.

        `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus) deprecated
        :   **Deprecated:** use dispositionStatuses instead

            Values of `EventDispositionStatus`

            `PENDING_REVIEW`
            :   ​

            `CLOSED_IGNORED`
            :   ​

            `CLOSED_REQUIRES_FURTHER_ACTION`
            :   ​

            `NO_DISPOSITION`
            :   ​

        **dispositionStatuses**

        Set `type` to `"dispositionStatuses"`.

        `dispositionStatuses` array of [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus)
        :   ​

        **priority**

        Set `type` to `"priority"`.

        `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority) deprecated
        :   **Deprecated:** use priorities instead

            Values of `Priority`

            `P0`
            :   ​

            `P1`
            :   ​

            `P2`
            :   ​

            `P3`
            :   ​

            `P4`
            :   ​

        **priorities**

        Set `type` to `"priorities"`.

        `priorities` array of [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
        :   ​

        **assignee**

        Set `type` to `"assignee"`.

        `assignee` string (RID) deprecated
        :   **Deprecated:** use assignees instead

        **assignees**

        Set `type` to `"assignees"`.

        `assignees` [`AssigneesFilter`](https://dev.nominal.io/api/legacy/event-service.md#assigneesfilter)
        :   ​

            Fields of `AssigneesFilter`

            `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
            :   ​

            `assignees` array of string (RID)
            :   ​

        **eventType**

        Set `type` to `"eventType"`.

        `eventType` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype) deprecated
        :   **Deprecated:** use eventTypes instead

            Values of `EventType`

            `INFO`
            :   ​

            `FLAG`
            :   ​

            `ERROR`
            :   ​

            `SUCCESS`
            :   ​

        **eventTypes**

        Set `type` to `"eventTypes"`.

        `eventTypes` array of [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
        :   ​

        **createdBy**

        Set `type` to `"createdBy"`.

        `createdBy` string (RID)
        :   ​

        **createdByAnyOf**

        Set `type` to `"createdByAnyOf"`.

        `createdByAnyOf` array of string (RID)
        :   ​

        **label**

        Set `type` to `"label"`.

        `label` string deprecated
        :   **Deprecated:** use labels instead

        **labels**

        Set `type` to `"labels"`.

        `labels` [`LabelsFilter`](https://dev.nominal.io/api/legacy/event-service.md#labelsfilter)
        :   ​

            Fields of `LabelsFilter`

            `operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
            :   ​

            `labels` array of string
            :   ​

        **property**

        Set `type` to `"property"`.

        `property` [`Property`](https://dev.nominal.io/api/legacy/event-service.md#property) deprecated
        :   **Deprecated:** use properties instead

            Fields of `Property`

            `name` string required
            :   ​

            `value` string required
            :   ​

        **properties**

        Set `type` to `"properties"`.

        `properties` [`PropertiesFilter`](https://dev.nominal.io/api/legacy/event-service.md#propertiesfilter)
        :   ​

            Fields of `PropertiesFilter`

            `name` string required
            :   ​

            `values` array of string
            :   ​

        **and**

        Set `type` to `"and"`.

        `and` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
        :   ​

        **or**

        Set `type` to `"or"`.

        `or` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
        :   ​

        **not**

        Set `type` to `"not"`.

        `not` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
        :   ​

        **workspace**

        Set `type` to `"workspace"`.

        `workspace` string (RID)
        :   ​

        **procedure**

        Set `type` to `"procedure"`.

        `procedure` string (RID)
        :   ​

        **procedureExecution**

        Set `type` to `"procedureExecution"`.

        `procedureExecution` string (RID)
        :   ​

        **stepId**

        Set `type` to `"stepId"`.

        `stepId` string
        :   ​

        **streamingChecklist**

        Set `type` to `"streamingChecklist"`.

        `streamingChecklist` string (RID)
        :   Filters to events created from a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

        **streamingCheck**

        Set `type` to `"streamingCheck"`.

        `streamingCheck` string (RID)
        :   Filters to events created from the check of a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

        **numericProperty**

        Set `type` to `"numericProperty"`.

        `numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertypredicate)
        :   Matches events using a numeric property comparison.

            Fields of `NumericPropertyPredicate`

            `name` string required
            :   ​

            `value` number required
            :   ​

            `operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/legacy/event-service.md#propertycomparisonoperator) required
            :   ​

                Values of `PropertyComparisonOperator`

                `EQ`
                :   ​

                `NEQ`
                :   ​

                `GT`
                :   ​

                `GTE`
                :   ​

                `LT`
                :   ​

                `LTE`
                :   ​

        **numericPropertyRange**

        Set `type` to `"numericPropertyRange"`.

        `numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangepredicate)
        :   Matches events using an inclusive numeric property range.

            Fields of `NumericPropertyRangePredicate`

            `name` string required
            :   ​

            `min` number
            :   ​

            `max` number
            :   ​

            `operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangeoperator) required
            :   ​

                Values of `NumericPropertyRangeOperator`

                `BETWEEN`
                :   ​

                `NOT_BETWEEN`
                :   ​

    `aggregateTypes` array of [`AggregateType`](https://dev.nominal.io/api/legacy/event-service.md#aggregatetype)
    :   ​

        Values of `AggregateType`

        `TOTAL_DURATION`
        :   ​

        `TOTAL_COUNT`
        :   ​

Response

`responses` array of [`AggregateEventsResponse`](https://dev.nominal.io/api/legacy/event-service.md#aggregateeventsresponse)
:   ​

    Fields of `AggregateEventsResponse`

    `values` map of string to [`AggregateValue`](https://dev.nominal.io/api/legacy/event-service.md#aggregatevalue)
    :   ​

        **duration**

        Set `type` to `"duration"`.

        `duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
        :   ​

            Fields of `Duration`

            `seconds` integer (int64)
            :   ​

            `nanos` integer (int64)
            :   ​

        **count**

        Set `type` to `"count"`.

        `count` integer
        :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/aggregate-events/batch" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "requests": [
    {
      "query": {
        "type": "archived",
        "archived": true
      }
    }
  ]
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/aggregate-events/batch",
    headers={"Authorization": "Bearer <api key>"},
    json={"requests": [{"query": {"type": "archived", "archived": True}}]},
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/aggregate-events/batch",
    headers={"Authorization": "Bearer <api key>"},
    json={"requests": [{"query": {"type": "archived", "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/v1/aggregate-events/batch",
            headers={"Authorization": "Bearer <api key>"},
            json={"requests": [{"query": {"type": "archived", "archived": True}}]},
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
{
  "responses": [
    {
      "values": {
        "<key>": {
          "type": "duration",
          "duration": {
            "seconds": 1,
            "nanos": 1
          }
        }
      }
    }
  ]
}
```

### Get events histogram

POST `/event/v1/histogram`

Gets a histogram of events that match the given filters.

Body

`startInclusive` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
:   ​

    Fields of `Timestamp`

    `seconds` integer (int64) required
    :   ​

    `nanos` integer (int64) required
    :   ​

`endExclusive` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
:   ​

`filterQuery` [`HistogramFilterQuery`](https://dev.nominal.io/api/legacy/event-service.md#histogramfilterquery)
:   The query to filter the events to be included in the histogram.

    **searchText**

    Set `type` to `"searchText"`.

    `searchText` string
    :   ​

    **asset**

    Set `type` to `"asset"`.

    `asset` string (RID)
    :   ​

    **template**

    Set `type` to `"template"`.

    `template` string (RID)
    :   ​

    **workbook**

    Set `type` to `"workbook"`.

    `workbook` string (RID)
    :   ​

    **dataReview**

    Set `type` to `"dataReview"`.

    `dataReview` string (RID)
    :   ​

    **originType**

    Set `type` to `"originType"`.

    `originType` [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype)
    :   ​

        Values of `SearchEventOriginType`

        `WORKBOOK`
        :   ​

        `TEMPLATE`
        :   ​

        `API`
        :   ​

        `DATA_REVIEW`
        :   ​

        `PROCEDURE`
        :   ​

        `STREAMING_CHECKLIST`
        :   ​

    **dataReviewCheck**

    Set `type` to `"dataReviewCheck"`.

    `dataReviewCheck` string (RID)
    :   ​

    **dispositionStatus**

    Set `type` to `"dispositionStatus"`.

    `dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus)
    :   ​

        Values of `EventDispositionStatus`

        `PENDING_REVIEW`
        :   ​

        `CLOSED_IGNORED`
        :   ​

        `CLOSED_REQUIRES_FURTHER_ACTION`
        :   ​

        `NO_DISPOSITION`
        :   ​

    **priority**

    Set `type` to `"priority"`.

    `priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
    :   ​

        Values of `Priority`

        `P0`
        :   ​

        `P1`
        :   ​

        `P2`
        :   ​

        `P3`
        :   ​

        `P4`
        :   ​

    **assignee**

    Set `type` to `"assignee"`.

    `assignee` string (RID)
    :   ​

    **eventType**

    Set `type` to `"eventType"`.

    `eventType` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
    :   ​

        Values of `EventType`

        `INFO`
        :   ​

        `FLAG`
        :   ​

        `ERROR`
        :   ​

        `SUCCESS`
        :   ​

    **createdBy**

    Set `type` to `"createdBy"`.

    `createdBy` string (RID)
    :   ​

    **label**

    Set `type` to `"label"`.

    `label` string
    :   ​

    **property**

    Set `type` to `"property"`.

    `property` [`Property`](https://dev.nominal.io/api/legacy/event-service.md#property)
    :   ​

        Fields of `Property`

        `name` string required
        :   ​

        `value` string required
        :   ​

    **and**

    Set `type` to `"and"`.

    `and` array of [`HistogramFilterQuery`](https://dev.nominal.io/api/legacy/event-service.md#histogramfilterquery)
    :   ​

    **or**

    Set `type` to `"or"`.

    `or` array of [`HistogramFilterQuery`](https://dev.nominal.io/api/legacy/event-service.md#histogramfilterquery)
    :   ​

    **not**

    Set `type` to `"not"`.

    `not` [`HistogramFilterQuery`](https://dev.nominal.io/api/legacy/event-service.md#histogramfilterquery)
    :   ​

    **workspace**

    Set `type` to `"workspace"`.

    `workspace` string (RID)
    :   ​

    **procedure**

    Set `type` to `"procedure"`.

    `procedure` string (RID)
    :   ​

    **procedureExecution**

    Set `type` to `"procedureExecution"`.

    `procedureExecution` string (RID)
    :   ​

    **stepId**

    Set `type` to `"stepId"`.

    `stepId` string
    :   ​

`archivedStatuses` array of [`ArchivedStatus`](https://dev.nominal.io/api/legacy/event-service.md#archivedstatus)
:   Filters search on check alerts based on the archived statuses provided. Default is NOT_ARCHIVED only if none are provided.

    Values of `ArchivedStatus`

    `NOT_ARCHIVED`
    :   ​

    `ARCHIVED`
    :   ​

`numBins` integer
:   Defaults to 100. Throws if larger than 1_000. The resulting histogram may have fewer bins than requested if the requested time window is too small.

`eventLimit` integer
:   Limits the number of events to be included in the histogram. Defaults to 1_000. Throws if larger than 10_000.

Response

`buckets` array of [`EventsHistogramBucket`](https://dev.nominal.io/api/legacy/event-service.md#eventshistogrambucket)
:   ​

    Fields of `EventsHistogramBucket`

    `startInclusive` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   ​

        Fields of `Timestamp`

        `seconds` integer (int64)
        :   ​

        `nanos` integer (int64)
        :   ​

    `endExclusive` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
    :   ​

    `count` integer
    :   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/histogram" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "startInclusive": {
    "seconds": 1,
    "nanos": 1
  },
  "endExclusive": {
    "seconds": 1,
    "nanos": 1
  }
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/histogram",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "startInclusive": {"seconds": 1, "nanos": 1},
        "endExclusive": {"seconds": 1, "nanos": 1},
    },
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/histogram",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "startInclusive": {"seconds": 1, "nanos": 1},
        "endExclusive": {"seconds": 1, "nanos": 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/v1/histogram",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "startInclusive": {"seconds": 1, "nanos": 1},
                "endExclusive": {"seconds": 1, "nanos": 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
    }
  ]
}
```

### List properties and labels

POST `/event/v1/list-properties-labels`

Lists the properties and labels of active events in the provided workspaces. Returns up to 500 of the most-used labels, and up to 500 of the most-used values for each property key. Property keys are not capped. Response maps and sets are unordered.

Body

`workspaces` array of string (RID)
:   If omitted, results will come from all workspaces the user belongs to.

Response

`properties` map of `PropertyName` to array of string deprecated
:   Legacy string-only property values. **Deprecated:** Use the paginated searchPropertyKeys and searchPropertyValues methods instead.

`labels` array of string
:   ​

Request

**curl**

```shell
curl -X POST "https://api.gov.nominal.io/api/event/v1/list-properties-labels" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "workspaces": [
    "<workspace rid>"
  ]
}'
```

**requests**

```python
import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v1/list-properties-labels",
    headers={"Authorization": "Bearer <api key>"},
    json={"workspaces": ["<workspace rid>"]},
)
response.raise_for_status()
print(response.json())
```

**httpx**

```python
import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v1/list-properties-labels",
    headers={"Authorization": "Bearer <api key>"},
    json={"workspaces": ["<workspace rid>"]},
)
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/v1/list-properties-labels",
            headers={"Authorization": "Bearer <api key>"},
            json={"workspaces": ["<workspace rid>"]},
        ) as response:
            response.raise_for_status()
            print(await response.json())

asyncio.run(main())
```

Response: `200`

```json
{
  "properties": {
    "<key>": [
      "<property value>"
    ]
  },
  "labels": [
    "<label>"
  ]
}
```

## Errors

[Errors](https://dev.nominal.io/api/legacy.md#errors) shows how these errors are sent.

Each error’s `errorName` is `Scout:` followed by its name below.

| Status | Name | Notes |
| --- | --- | --- |
| 400 | `IllegalBinCountRequested` |  |
| 400 | `IllegalEventLimitRequested` |  |
| 400 | `MissingAssetRid` |  |
| 404 | `EventNotFound` |  |
| 404 | `EventsNotFound` |  |
| 404 | `RidsNotFound` |  |

## Types

### AggregateEventsRequest

`query` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery) required
:   ​

`aggregateTypes` array of [`AggregateType`](https://dev.nominal.io/api/legacy/event-service.md#aggregatetype)
:   ​

### AggregateEventsResponse

`values` map of string to [`AggregateValue`](https://dev.nominal.io/api/legacy/event-service.md#aggregatevalue)
:   ​

### AggregateType

`TOTAL_DURATION`
:   ​

`TOTAL_COUNT`
:   ​

### AggregateValue

Set `type` to the name of one of the other fields, and set only that field.

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
:   ​

`count` integer
:   ​

### ApiEventOrigin

An empty JSON object, `{}`.

### ArchivedStatus

`NOT_ARCHIVED`
:   ​

`ARCHIVED`
:   ​

### AssetsFilter

`operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
:   ​

`assets` array of string (RID)
:   ​

### AssigneesFilter

`operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
:   ​

`assignees` array of string (RID)
:   ​

### CheckOriginMetadata

`checkEvaluationRid` string (RID) required
:   ​

`checkRid` string (RID) required
:   ​

`checkLineageRid` string (RID) required
:   ​

`implementationIndex` integer
:   ​

### ClosedWithFurtherActionDispositionState

`closedBy` string (RID) required
:   ​

### ClosedWithIgnoreDispositionState

`closedBy` string (RID) required
:   ​

### DataReviewChecksFilter

`dataReviewChecks` array of string (RID)
:   ​

### DataReviewEventOrigin

`dataReviewRid` string (RID) required
:   ​

`checkMetadata` [`CheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#checkoriginmetadata) required
:   Metadata about the check that created this event.

### DataReviewsFilter

`dataReviews` array of string (RID)
:   ​

### DispositionState

Set `type` to the name of one of the other fields, and set only that field.

`pendingReview` [`PendingReviewDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#pendingreviewdispositionstate)
:   ​

`closedWithFurtherAction` [`ClosedWithFurtherActionDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithfurtheractiondispositionstate)
:   ​

`closedWithIgnore` [`ClosedWithIgnoreDispositionState`](https://dev.nominal.io/api/legacy/event-service.md#closedwithignoredispositionstate)
:   ​

### Duration

`seconds` integer (int64) required
:   ​

`nanos` integer (int64) required
:   ​

### Event

`uuid` string (UUID) required deprecated
:   **Deprecated:** This field is deprecated. Use the rid field instead.

`rid` string (RID) required
:   ​

`assetRids` array of string (RID)
:   A set of asset rids associated with the event.

`origins` array of [`EventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#eventorigin)
:   A set of origins associated with the event.

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
:   ​

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration) required
:   ​

`name` string required
:   ​

`description` string required
:   ​

`type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype) required
:   ​

`labels` array of string
:   ​

`properties` map of `PropertyName` to string deprecated
:   **Deprecated:** use typedProperties

`typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
:   ​

`isArchived` boolean required
:   ​

`createdBy` string (RID)
:   The user who created the event. This field may be missing for legacy events.

`disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
:   ​

### EventDisposition

Describes the review status for an event. This is used to track the disposition status of an event.

`priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority) required
:   ​

`state` [`DispositionState`](https://dev.nominal.io/api/legacy/event-service.md#dispositionstate) required
:   ​

`assignees` array of string (RID)
:   ​

### EventDispositionStatus

`PENDING_REVIEW`
:   ​

`CLOSED_IGNORED`
:   ​

`CLOSED_REQUIRES_FURTHER_ACTION`
:   ​

`NO_DISPOSITION`
:   ​

### EventOrigin

Describes where an event came from.

Set `type` to the name of one of the other fields, and set only that field.

`workbook` [`WorkbookEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#workbookeventorigin)
:   This event was created in this workbook

`template` [`TemplateEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#templateeventorigin)
:   This event was created in this template

`api` [`ApiEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#apieventorigin)
:   This event was created programmatically via the API

`dataReview` [`DataReviewEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#datarevieweventorigin)
:   This event was created automatically from a checklist execution.

`procedure` [`ProcedureEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#procedureeventorigin)
:   This event was created automatically from a procedure execution.

`streamingChecklist` [`StreamingChecklistEventOrigin`](https://dev.nominal.io/api/legacy/event-service.md#streamingchecklisteventorigin)
:   This event was created automatically from the execution of a streaming checklist.

### EventsHistogramBucket

`startInclusive` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
:   ​

`endExclusive` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
:   ​

`count` integer required
:   ​

### EventTimeFilter

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp) required
:   ​

`timestampCondition` [`EventTimeFilterCondition`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefiltercondition) required
:   ​

### EventTimeFilterCondition

`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

`INFO`
:   ​

`FLAG`
:   ​

`ERROR`
:   ​

`SUCCESS`
:   ​

### HistogramFilterQuery

Set `type` to the name of one of the other fields, and set only that field.

`searchText` string
:   ​

`asset` string (RID)
:   ​

`template` string (RID)
:   ​

`workbook` string (RID)
:   ​

`dataReview` string (RID)
:   ​

`originType` [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype)
:   ​

`dataReviewCheck` string (RID)
:   ​

`dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus)
:   ​

`priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
:   ​

`assignee` string (RID)
:   ​

`eventType` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
:   ​

`createdBy` string (RID)
:   ​

`label` string
:   ​

`property` [`Property`](https://dev.nominal.io/api/legacy/event-service.md#property)
:   ​

`and` array of [`HistogramFilterQuery`](https://dev.nominal.io/api/legacy/event-service.md#histogramfilterquery)
:   ​

`or` array of [`HistogramFilterQuery`](https://dev.nominal.io/api/legacy/event-service.md#histogramfilterquery)
:   ​

`not` [`HistogramFilterQuery`](https://dev.nominal.io/api/legacy/event-service.md#histogramfilterquery)
:   ​

`workspace` string (RID)
:   ​

`procedure` string (RID)
:   ​

`procedureExecution` string (RID)
:   ​

`stepId` string
:   ​

### LabelsFilter

`operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
:   ​

`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 required
:   ​

`value` number required
:   ​

`operator` [`PropertyComparisonOperator`](https://dev.nominal.io/api/legacy/event-service.md#propertycomparisonoperator) required
:   ​

### NumericPropertyRangeOperator

`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 required
:   ​

`min` number
:   ​

`max` number
:   ​

`operator` [`NumericPropertyRangeOperator`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangeoperator) required
:   ​

### OriginTypesFilter

`operator` [`SetOperator`](https://dev.nominal.io/api/legacy/event-service.md#setoperator) required
:   ​

`originTypes` array of [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype)
:   ​

### PendingReviewDispositionState

`openedBy` string (RID) required
:   ​

### Priority

`P0`
:   ​

`P1`
:   ​

`P2`
:   ​

`P3`
:   ​

`P4`
:   ​

### ProcedureEventOrigin

`procedureExecutionRid` string (RID) required
:   ​

`procedureRid` string (RID) required
:   ​

`stepId` string required
:   ​

### PropertiesFilter

`name` string required
:   ​

`values` array of string
:   ​

### Property

`name` string required
:   ​

`value` string required
:   ​

### PropertyComparisonOperator

`EQ`
:   ​

`NEQ`
:   ​

`GT`
:   ​

`GTE`
:   ​

`LT`
:   ​

`LTE`
:   ​

### SearchEventOriginType

`WORKBOOK`
:   ​

`TEMPLATE`
:   ​

`API`
:   ​

`DATA_REVIEW`
:   ​

`PROCEDURE`
:   ​

`STREAMING_CHECKLIST`
:   ​

### SearchQuery

Set `type` to the name of one of the other fields, and set only that field.

`archived` boolean
:   ​

`searchText` string
:   Search text to perform fuzzy searching against.

`exactMatch` string
:   Search text to perform exact matching against on the event name and description.

`after` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
:   Filters to events after this timestamp, exclusive. This includes events that start before, but end after this time.

`before` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
:   Filters to events before this timestamp, exclusive. This includes events that start before, but end after this time.

`advancedTimeFilter` [`EventTimeFilter`](https://dev.nominal.io/api/legacy/event-service.md#eventtimefilter)
:   ​

`asset` string (RID) deprecated
:   **Deprecated:** use assetRids

`assets` [`AssetsFilter`](https://dev.nominal.io/api/legacy/event-service.md#assetsfilter)
:   ​

`template` string (RID)
:   ​

`workbook` string (RID)
:   ​

`dataReview` string (RID) deprecated
:   **Deprecated:** use dataReviews instead

`dataReviews` [`DataReviewsFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewsfilter)
:   ​

`originType` [`SearchEventOriginType`](https://dev.nominal.io/api/legacy/event-service.md#searcheventorigintype) deprecated
:   **Deprecated:** use originTypes instead

`originTypes` [`OriginTypesFilter`](https://dev.nominal.io/api/legacy/event-service.md#origintypesfilter)
:   ​

`dataReviewCheck` string (RID) deprecated
:   **Deprecated:** use dataReviewChecks instead

`dataReviewChecks` [`DataReviewChecksFilter`](https://dev.nominal.io/api/legacy/event-service.md#datareviewchecksfilter)
:   ​

`dispositionStatus` [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus) deprecated
:   **Deprecated:** use dispositionStatuses instead

`dispositionStatuses` array of [`EventDispositionStatus`](https://dev.nominal.io/api/legacy/event-service.md#eventdispositionstatus)
:   ​

`priority` [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority) deprecated
:   **Deprecated:** use priorities instead

`priorities` array of [`Priority`](https://dev.nominal.io/api/legacy/event-service.md#priority)
:   ​

`assignee` string (RID) deprecated
:   **Deprecated:** use assignees instead

`assignees` [`AssigneesFilter`](https://dev.nominal.io/api/legacy/event-service.md#assigneesfilter)
:   ​

`eventType` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype) deprecated
:   **Deprecated:** use eventTypes instead

`eventTypes` array of [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
:   ​

`createdBy` string (RID)
:   ​

`createdByAnyOf` array of string (RID)
:   ​

`label` string deprecated
:   **Deprecated:** use labels instead

`labels` [`LabelsFilter`](https://dev.nominal.io/api/legacy/event-service.md#labelsfilter)
:   ​

`property` [`Property`](https://dev.nominal.io/api/legacy/event-service.md#property) deprecated
:   **Deprecated:** use properties instead

`properties` [`PropertiesFilter`](https://dev.nominal.io/api/legacy/event-service.md#propertiesfilter)
:   ​

`and` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
:   ​

`or` array of [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
:   ​

`not` [`SearchQuery`](https://dev.nominal.io/api/legacy/event-service.md#searchquery)
:   ​

`workspace` string (RID)
:   ​

`procedure` string (RID)
:   ​

`procedureExecution` string (RID)
:   ​

`stepId` string
:   ​

`streamingChecklist` string (RID)
:   Filters to events created from a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

`streamingCheck` string (RID)
:   Filters to events created from the check of a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance.

`numericProperty` [`NumericPropertyPredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertypredicate)
:   Matches events using a numeric property comparison.

`numericPropertyRange` [`NumericPropertyRangePredicate`](https://dev.nominal.io/api/legacy/event-service.md#numericpropertyrangepredicate)
:   Matches events using an inclusive numeric property range.

### SetOperator

`AND`
:   ​

`OR`
:   ​

### SortField

`START_TIME`
:   ​

`END_TIME`
:   ​

`DURATION`
:   ​

`DISPOSITION_STATUS`
:   ​

`PRIORITY`
:   ​

`EVENT_NAME`
:   ​

### SortOptions

`isDescending` boolean required
:   ​

`field` [`SortField`](https://dev.nominal.io/api/legacy/event-service.md#sortfield) required
:   ​

### StreamingChecklistEventOrigin

`checklistRid` string (RID) required
:   ​

`checkMetadata` [`StreamingCheckOriginMetadata`](https://dev.nominal.io/api/legacy/event-service.md#streamingcheckoriginmetadata) required
:   Metadata about the check that created this event.

### StreamingCheckOriginMetadata

`checkRid` string (RID) required
:   ​

`checkLineageRid` string (RID) required
:   ​

`implementationIndex` integer
:   ​

### TemplateEventOrigin

`rid` string (RID) required
:   ​

### TimeSeriesChannelAssociation

A singular time series to associate the event with.

`variableName` string required
:   ​

`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 in proto APIs.

This legacy nanosecond precision timestamp type 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` integer (int64) required
:   ​

`nanos` integer (int64) required
:   ​

### TypedPropertyValue

Typed metadata value. Additional variants may be added as property types expand.

Set `type` to the name of one of the other fields, and set only that field.

`stringValue` string
:   ​

`numericValue` number
:   ​

### UpdateDispositionRequest

`rid` string (RID) required
:   ​

`disposition` [`EventDisposition`](https://dev.nominal.io/api/legacy/event-service.md#eventdisposition)
:   The new disposition for the event. If empty, will remove the disposition from the event.

### UpdateEventRequest

`rid` string (RID) required
:   ​

`assetRids` array of string (RID)
:   If provided, will replace the existing asset rids. If provided, must contain at least one asset rid.

`timestamp` [`Timestamp`](https://dev.nominal.io/api/legacy/event-service.md#timestamp)
:   ​

`duration` [`Duration`](https://dev.nominal.io/api/legacy/event-service.md#duration)
:   ​

`name` string
:   ​

`description` string
:   ​

`type` [`EventType`](https://dev.nominal.io/api/legacy/event-service.md#eventtype)
:   ​

`labels` array of string
:   ​

`properties` map of `PropertyName` to string deprecated
:   **Deprecated:** use typedProperties

`typedProperties` map of `PropertyName` to [`TypedPropertyValue`](https://dev.nominal.io/api/legacy/event-service.md#typedpropertyvalue)
:   ​

### WorkbookDataAssociation

Set `type` to the name of one of the other fields, and set only that field.

`timeSeriesChannel` [`TimeSeriesChannelAssociation`](https://dev.nominal.io/api/legacy/event-service.md#timeserieschannelassociation)
:   ​

### WorkbookEventOrigin

`rid` string (RID) required
:   ​

`data` array of [`WorkbookDataAssociation`](https://dev.nominal.io/api/legacy/event-service.md#workbookdataassociation)
:   Data visualizations to associate this event with

Page design based on [Scalar](https://scalar.com), MIT License.