Skip to main content
GET
/
api
/
v2
/
calculated-channels
/
resolved
ListResolvedCalculatedChannels
curl --request GET \
  --url https://your-sift-api-url.com/api/v2/calculated-channels/resolved \
  --header 'Authorization: Bearer <token>'
{
  "calculatedChannelResolutions": [
    {
      "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"
          }
        ]
      },
      "resolved": [
        {
          "assetName": "<string>",
          "expressionRequest": {
            "channelReferences": {},
            "expression": "<string>",
            "expressionChannelReferences": [
              {
                "channelReference": "<string>",
                "channelId": "<string>"
              }
            ],
            "functionDependencies": [
              {
                "userDefinedFunctionVersionId": "<string>"
              }
            ]
          },
          "outputDataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
          "assetId": "<string>"
        }
      ],
      "unresolved": [
        {
          "assetName": "<string>",
          "errorMessage": "<string>"
        }
      ]
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
assetId
string

Assets or runs to get the resolved calculated channels for. At least one asset or run must be provided.

​
runId
string
​
pageSize
integer

The maximum number of calculated channels to return. The service may return fewer than this value. If unspecified, at most 50 calculated channels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

​
pageToken
string

A page token, received from a previous ListCalculatedChannels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCalculatedChannels must match the call that provided the page token. Optional.

​
filter
string

A Common Expression Language (CEL) filter string. Available fields to filter by are calculated_channel_id, client_key, name, asset_id, asset_name, tag_id, tag_name, version, and `archived_date. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

​
orderBy
string

How to order the retrieved calculated channels. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date and modified_date. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

Response

A successful response.

​
calculatedChannelResolutions
object[]
required
​
nextPageToken
string