Search for events

async AsyncCogniteClient.events.search(

description: str | None = None,

filter: EventFilter | dict[str, Any] | None = None,

limit: int = 25,

) → EventList

Search for events.

Primarily meant for human-centric use-cases and data exploration, not for programs, since matching and ordering may change over time. Use the list function if stable or exact matches are required.

Parameters:

• description (str | None) – Fuzzy match on description.

• filter (EventFilter | dict[str, Any] | None) – Filter to apply. Performs exact match on these fields.

• limit (int) – Maximum number of results to return.

Returns:

List of requested events

Return type:

EventList

Examples

Search for events:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.events.search(description="some description")