Skip to main content
GET
/
api
/
v3
/
channels:filter
EXPERIMENTAL: This RPC is experimental and only available to a limited set of users.
curl --request GET \
  --url https://your-sift-api-url.com/api/v3/channels:filter \
  --header 'Authorization: Bearer <token>'
{
  "channels": [
    {
      "channelId": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "assetId": "<string>",
      "assetName": "<string>",
      "description": "<string>",
      "displayDescription": "<string>",
      "unitId": "<string>",
      "displayUnitId": "<string>",
      "unit": "<string>",
      "displayUnit": "<string>",
      "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
      "enumTypes": [
        {
          "name": "<string>",
          "key": 123,
          "isSigned": true
        }
      ],
      "bitFieldElements": [
        {
          "name": "<string>",
          "index": 123,
          "bitCount": 123
        }
      ],
      "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"
        }
      ]
    }
  ],
  "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
pageToken
string
searchTerm
string

The search term to match against channel names, components and descriptions. Optional.

isSearchCaseSensitive
boolean

If true, the search term is case sensitive. Optional, default false.

isSearchRegexp
boolean

If true, the search term is treated as a regular expression. Optional, default false.

assetIds
string[]

If provided, only channels matching these asset_ids are returned. Optional

runIds
string[]

Only channels for these runs are returned. Optional

channelIds
string[]

If provided, only channels matching these channel_ids are returned. Optional

assetTagIds
string[]

If provided, only channels with assets with these tag_ids are returned. Optional

dataTypes
enum<string>[]

If provide, only channels with these data types are returned. Optional.

metadataKeys
string[]

If provided, only channels with this metadata are returned. Optional.

metadataValues
string[]

Response

A successful response.

The result of a call to ChannelService_FilterChannels.

channels
object[]
nextPageToken
string