Retrieve a datapoint subscription by id(s)

async AsyncCogniteClient.time_series.subscriptions.retrieve(

external_id: str,

) → DatapointSubscription | None

Retrieve one subscription by external ID.

Parameters:

external_id (str) – External ID of the subscription to retrieve.

Returns:

The requested subscription.

Return type:

DatapointSubscription | None

Examples

Retrieve a subscription by external ID:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.time_series.subscriptions.retrieve("my_subscription")