Skip to main content
GET
/
api
/
v2
/
calculated-channels
/
{calculatedChannelId}
GetCalculatedChannel
curl --request GET \
  --url https://your-sift-api-url.com/api/v2/calculated-channels/{calculatedChannelId} \
  --header 'Authorization: Bearer <token>'
{
  "calculatedChannel": {
    "calculatedChannelId": "<string>",
    "organizationId": "<string>",
    "clientKey": "<string>",
    "archivedDate": "2023-11-07T05:31:56Z",
    "versionId": "<string>",
    "version": 123,
    "name": "<string>",
    "description": "<string>",
    "changeMessage": "<string>",
    "userNotes": "<string>",
    "units": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "calculatedChannelConfiguration": {
      "assetConfiguration": {
        "allAssets": true,
        "selection": {
          "assetIds": [
            "<string>"
          ],
          "tagIds": [
            "<string>"
          ]
        }
      },
      "queryConfiguration": {
        "sel": {
          "expression": "<string>",
          "expressionChannelReferences": [
            {
              "channelReference": "<string>",
              "channelIdentifier": "<string>"
            }
          ]
        }
      }
    },
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "functionDependencies": [
      {
        "userDefinedFunctionVersionId": "<string>"
      }
    ],
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z"
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "archivedDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

calculatedChannelId
string
required

Query Parameters

clientKey
string
organizationId
string

Response

A successful response.

calculatedChannel
object
required