ListCalculatedChannels

Retrieve the latest versions of calculated channels based on an optional filter.

GET /api/v2/calculated-channels

ListCalculatedChannels

cURL

curl --request GET \
  --url https://api.siftstack.com/api/v2/calculated-channels \
  --header 'Authorization: Bearer <token>'

200

{
  "calculatedChannels": [
    {
      "calculatedChannelId": "<string>",
      "organizationId": "<string>",
      "versionId": "<string>",
      "version": 123,
      "name": "<string>",
      "description": "<string>",
      "changeMessage": "<string>",
      "userNotes": "<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>",
                "calculatedChannelVersionId": "<string>",
                "calculatedChannel": {
                  "expression": "<string>",
                  "channelReferences": {},
                  "expressionChannelReferences": [
                    {
                      "channelReference": "<string>",
                      "channelId": "<string>",
                      "calculatedChannel": "<unknown>"
                    }
                  ],
                  "functionDependencies": [
                    {
                      "userDefinedFunctionVersionId": "<string>"
                    }
                  ]
                }
              }
            ]
          }
        }
      },
      "createdByUserId": "<string>",
      "modifiedByUserId": "<string>",
      "functionDependencies": [
        {
          "userDefinedFunctionVersionId": "<string>"
        }
      ],
      "metadata": [
        {
          "key": {
            "name": "<string>",
            "type": "METADATA_KEY_TYPE_UNSPECIFIED",
            "archivedDate": "2023-11-07T05:31:56Z",
            "isArchived": true
          },
          "stringValue": "<string>",
          "numberValue": 123,
          "booleanValue": true,
          "relationValue": {
            "resourceType": "<string>",
            "resourceId": "<string>"
          },
          "archivedDate": "2023-11-07T05:31:56Z",
          "isArchived": true
        }
      ],
      "isArchived": true,
      "calculatedChannelDependencies": [
        {
          "calculatedChannelVersionId": "<string>"
        }
      ],
      "clientKey": "<string>",
      "archivedDate": "2023-11-07T05:31:56Z",
      "units": "<string>",
      "folderIds": [
        "<string>"
      ]
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

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

Query Parameters

pageSize · integer<int64>

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, organization_id, client_key, name, description, asset_id, asset_name, tag_id, tag_name, units, calculated_channel_version_id, created_date, modified_date, created_by_user_id, modified_by_user_id, is_archived, and archived_date. Folder membership is filterable via the folders and activeFolders fields. Both contain the ids of the folders the calculated channel belongs to; activeFolders excludes archived folders. Use "<folder_id>" in folders to return calculated channels in the given folder, and size(activeFolders) == 0 to return uncategorized calculated channels (calculated channels whose only memberships are in archived folders count as uncategorized). For further information about how to use CELs, please refer to this guide.

organizationId · string

This field is only required if your user belongs to multiple organizations.

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, modified_date, name, description, units, and archived_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

200

application/json

A successful response.

The response of a call to CalculatedChannelService_ListCalculatedChannels.

calculatedChannels · object[] · required

Show child attributes

nextPageToken · string