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

Endpoints#

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

Errors#

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 required
aggregateTypes array of AggregateType

AggregateEventsResponse#

values map of string to 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
count integer

ApiEventOrigin#

An empty JSON object, {}.

ArchivedStatus#

NOT_ARCHIVED
ARCHIVED

AssetsFilter#

operator SetOperator required
assets array of string (RID)

AssigneesFilter#

operator 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 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
closedWithFurtherAction ClosedWithFurtherActionDispositionState
closedWithIgnore 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: A set of origins associated with the event.
timestamp Timestamp required
duration Duration required
name string required
description string required
type EventType required
labels array of string
properties map of PropertyName to string deprecated: Deprecated: use typedProperties
typedProperties map of PropertyName to TypedPropertyValue
isArchived boolean required
createdBy string (RID): The user who created the event. This field may be missing for legacy events.
disposition EventDisposition

EventDisposition#

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

priority Priority required
state 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: This event was created in this workbook
template TemplateEventOrigin: This event was created in this template
api ApiEventOrigin: This event was created programmatically via the API
dataReview DataReviewEventOrigin: This event was created automatically from a checklist execution.
procedure ProcedureEventOrigin: This event was created automatically from a procedure execution.
streamingChecklist StreamingChecklistEventOrigin: This event was created automatically from the execution of a streaming checklist.

EventsHistogramBucket#

startInclusive Timestamp required
endExclusive Timestamp required
count integer required

EventTimeFilter#

timestamp Timestamp required
timestampCondition 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
dataReviewCheck string (RID)
dispositionStatus EventDispositionStatus
priority Priority
assignee string (RID)
eventType EventType
createdBy string (RID)
label string
property Property
and array of HistogramFilterQuery
or array of HistogramFilterQuery
not HistogramFilterQuery
workspace string (RID)
procedure string (RID)
procedureExecution string (RID)
stepId string

LabelsFilter#

operator 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 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 required

OriginTypesFilter#

operator SetOperator required
originTypes array of 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: Filters to events after this timestamp, exclusive. This includes events that start before, but end after this time.
before Timestamp: Filters to events before this timestamp, exclusive. This includes events that start before, but end after this time.
advancedTimeFilter EventTimeFilter
asset string (RID) deprecated: Deprecated: use assetRids
assets AssetsFilter
template string (RID)
workbook string (RID)
dataReview string (RID) deprecated: Deprecated: use dataReviews instead
dataReviews DataReviewsFilter
originType SearchEventOriginType deprecated: Deprecated: use originTypes instead
originTypes OriginTypesFilter
dataReviewCheck string (RID) deprecated: Deprecated: use dataReviewChecks instead
dataReviewChecks DataReviewChecksFilter
dispositionStatus EventDispositionStatus deprecated: Deprecated: use dispositionStatuses instead
dispositionStatuses array of EventDispositionStatus
priority Priority deprecated: Deprecated: use priorities instead
priorities array of Priority
assignee string (RID) deprecated: Deprecated: use assignees instead
assignees AssigneesFilter
eventType EventType deprecated: Deprecated: use eventTypes instead
eventTypes array of EventType
createdBy string (RID)
createdByAnyOf array of string (RID)
label string deprecated: Deprecated: use labels instead
labels LabelsFilter
property Property deprecated: Deprecated: use properties instead
properties PropertiesFilter
and array of SearchQuery
or array of SearchQuery
not 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: Matches events using a numeric property comparison.
numericPropertyRange 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 required

StreamingChecklistEventOrigin#

checklistRid string (RID) required
checkMetadata 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: 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
duration Duration
name string
description string
type EventType
labels array of string
properties map of PropertyName to string deprecated: Deprecated: use typedProperties
typedProperties map of PropertyName to TypedPropertyValue

WorkbookDataAssociation#

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

timeSeriesChannel TimeSeriesChannelAssociation

WorkbookEventOrigin#

rid string (RID) required
data array of WorkbookDataAssociation: Data visualizations to associate this event with

Page design based on Scalar, MIT License.

Event service#

Endpoints#

Create event#

Get events#

Batch get events#

Batch filter events#

Update event#

Batch update event#

Batch update disposition#

Archive event#

Batch archive event#

Batch unarchive event#

Search events#

Aggregate events#

Batch aggregate events#

Get events histogram#

List properties and labels#

Errors#

Types#

AggregateEventsRequest#

AggregateEventsResponse#

AggregateType#

AggregateValue#

ApiEventOrigin#

ArchivedStatus#

AssetsFilter#

AssigneesFilter#

CheckOriginMetadata#

ClosedWithFurtherActionDispositionState#

ClosedWithIgnoreDispositionState#

DataReviewChecksFilter#

DataReviewEventOrigin#

DataReviewsFilter#

DispositionState#

Duration#

Event#

EventDisposition#

EventDispositionStatus#

EventOrigin#

EventsHistogramBucket#

EventTimeFilter#

EventTimeFilterCondition#

EventType#

HistogramFilterQuery#

LabelsFilter#

NumericPropertyPredicate#

NumericPropertyRangeOperator#

NumericPropertyRangePredicate#

OriginTypesFilter#

PendingReviewDispositionState#

Priority#

ProcedureEventOrigin#

PropertiesFilter#

Property#

PropertyComparisonOperator#

SearchEventOriginType#

SearchQuery#

SetOperator#

SortField#

SortOptions#

StreamingChecklistEventOrigin#

StreamingCheckOriginMetadata#

TemplateEventOrigin#

TimeSeriesChannelAssociation#

Timestamp#

TypedPropertyValue#

UpdateDispositionRequest#

UpdateEventRequest#

WorkbookDataAssociation#

WorkbookEventOrigin#