Search for time series

async AsyncCogniteClient.time_series.search(
name: str | None = None,
description: str | None = None,
query: str | None = None,
filter: TimeSeriesFilter | dict[str, Any] | None = None,
limit: int = 25,
) → TimeSeriesList

Search for time series.

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:

  • name (str | None) – Prefix and fuzzy search on name.

  • description (str | None) – Prefix and fuzzy search on description.

  • query (str | None) – Search on name and description using wildcard search on each of the words (separated by spaces). Retrieves results where at least one word must match. Example: ‘some other’

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

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

Returns:

List of requested time series.

Return type:

TimeSeriesList

Examples

Search for a time series:

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

Search for all time series connected to asset with id 123:

>>> res = client.time_series.search(filter={"asset_ids": [123]})