Skip to main content
POST
/
timeseries
/
subscriptions
/
byids
Python SDK
res = client.time_series.subscriptions.retrieve("my_subscription")
{
  "items": [
    {
      "externalId": "my.known.id",
      "partitionCount": 50,
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "name": "<string>",
      "description": "<string>",
      "dataSetId": 4503599627370496,
      "timeSeriesCount": 123,
      "filter": {
        "or": [
          {
            "not": {
              "and": [
                {
                  "equals": {
                    "property": [
                      "metadata",
                      "manufacturer"
                    ],
                    "value": "acme"
                  }
                },
                {
                  "in": {
                    "property": [
                      "name"
                    ],
                    "values": [
                      "pump-1-temperature",
                      "motor-9-temperature"
                    ]
                  }
                },
                {
                  "range": {
                    "property": [
                      "dataSetId"
                    ],
                    "gte": 1,
                    "lt": 10
                  }
                }
              ]
            }
          },
          {
            "and": [
              {
                "equals": {
                  "property": [
                    "assetId"
                  ],
                  "value": 1234
                }
              },
              {
                "equals": {
                  "property": [
                    "description"
                  ],
                  "value": "Temperature in Celsius"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json

Specify a list of the subscriptions to retrieve.

items
QueryWithExternalId · object[]
required

List of ID objects

Required array length: 1 element
ignoreUnknownIds
boolean
default:false

Ignore IDs and external IDs that are not found

Response

200 - application/json

The retrieved subscriptions.

List of subscriptions.

items
object[]
required
Last modified on April 23, 2026