> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
> Use this file to discover all available pages before exploring further.
# channels
> sift/channels/v3/channels.proto
## Services
*RPC methods exposed by this API.*
### ChannelService
| Method | Request | Response | Description |
| :--------------------- | :-------------------------------------------------------------- | :---------------------------------------------------------------- | :--------------------------------------------------- |
| GetChannel | [GetChannelRequest](#getchannelrequest) | [GetChannelResponse](#getchannelresponse) | Retrieve a channel |
| ListChannels | [ListChannelsRequest](#listchannelsrequest) | [ListChannelsResponse](#listchannelsresponse) | Retrieve channels using an optional filter. |
| UpdateChannel | [UpdateChannelRequest](#updatechannelrequest) | [UpdateChannelResponse](#updatechannelresponse) | Update a channel |
| BatchArchiveChannels | [BatchArchiveChannelsRequest](#batcharchivechannelsrequest) | [BatchArchiveChannelsResponse](#batcharchivechannelsresponse) | Batch archives channels by setting active to false. |
| BatchUnarchiveChannels | [BatchUnarchiveChannelsRequest](#batchunarchivechannelsrequest) | [BatchUnarchiveChannelsResponse](#batchunarchivechannelsresponse) | Batch unarchives channels by setting active to true. |
## Messages
*Data models used across requests/responses.*
### BatchArchiveChannelsRequest
The request for a call to ChannelService\_BatchArchiveChannels.
| Field | Type | Label | Description |
| :----------- | :----- | :------- | :---------- |
| channel\_ids | string | repeated | |
### BatchArchiveChannelsResponse
The result of a call to ChannelService\_BatchArchiveChannels.
*This message has no fields.*
### BatchUnarchiveChannelsRequest
The request for a call to ChannelService\_BatchUnarchiveChannels.
| Field | Type | Label | Description |
| :----------- | :----- | :------- | :---------- |
| channel\_ids | string | repeated | |
### BatchUnarchiveChannelsResponse
The result of a call to ChannelService\_BatchUnarchiveChannels.
*This message has no fields.*
### Channel
| Field | Type | Label | Description |
| :--------------------- | :---------------------------------------------------------------------------------------- | :------- | :---------------------------- |
| channel\_id | string | | |
| name | string | | The full name of the channel. |
| asset\_id | string | | |
| description | string | | |
| unit\_id | string | | |
| created\_date | google.protobuf.Timestamp | | |
| modified\_date | google.protobuf.Timestamp | | |
| created\_by\_user\_id | string | | |
| modified\_by\_user\_id | string | | |
| data\_type | [sift.common.type.v1.ChannelDataType](#sift-common-type-v1-channeldatatype) | | |
| enum\_types | [sift.common.type.v1.ChannelEnumType](#sift-common-type-v1-channelenumtype) | repeated | |
| bit\_field\_elements | [sift.common.type.v1.ChannelBitFieldElement](#sift-common-type-v1-channelbitfieldelement) | repeated | |
| display\_description | string | | |
| display\_unit\_id | string | | |
| metadata | [sift.metadata.v1.MetadataValue](#sift-metadata-v1-metadatavalue) | repeated | |
| active | bool | | |
### FilterChannel
| Field | Type | Label | Description |
| :------------------- | :---------------------------------------------------------------------------------------- | :------- | :---------- |
| channel\_id | string | | |
| name | string | | |
| organization\_id | string | | |
| asset\_id | string | | |
| asset\_name | string | | |
| description | string | | |
| display\_description | string | | |
| unit\_id | string | | |
| display\_unit\_id | string | | |
| unit | string | | |
| display\_unit | string | | |
| data\_type | [sift.common.type.v1.ChannelDataType](#sift-common-type-v1-channeldatatype) | | |
| enum\_types | [sift.common.type.v1.ChannelEnumType](#sift-common-type-v1-channelenumtype) | repeated | |
| bit\_field\_elements | [sift.common.type.v1.ChannelBitFieldElement](#sift-common-type-v1-channelbitfieldelement) | repeated | |
| metadata | [sift.metadata.v1.MetadataValue](#sift-metadata-v1-metadatavalue) | repeated | |
### FilterChannelsRequest
The request for a call to ChannelService\_FilterChannels.
| Field | Type | Label | Description |
| :-------------------------- | :-------------------------------------------------------------------------- | :------- | :------------------------------------------------------------------------------------- |
| page\_size | uint32 | | |
| page\_token | string | | |
| search\_term | string | | The search term to match against channel names, components and descriptions. Optional. |
| is\_search\_case\_sensitive | bool | | If true, the search term is case sensitive. Optional, default false. |
| is\_search\_regexp | bool | | If true, the search term is treated as a regular expression. Optional, default false. |
| asset\_ids | string | repeated | If provided, only channels matching these asset\_ids are returned. Optional |
| run\_ids | string | repeated | Only channels for these runs are returned. Optional |
| channel\_ids | string | repeated | If provided, only channels matching these channel\_ids are returned. Optional |
| asset\_tag\_ids | string | repeated | If provided, only channels with assets with these tag\_ids are returned. Optional |
| data\_types | [sift.common.type.v1.ChannelDataType](#sift-common-type-v1-channeldatatype) | repeated | If provide, only channels with these data types are returned. Optional. |
| metadata\_keys | string | repeated | If provided, only channels with this metadata are returned. Optional. |
| metadata\_values | string | repeated | |
### FilterChannelsResponse
The result of a call to ChannelService\_FilterChannels.
| Field | Type | Label | Description |
| :---------------- | :------------------------------ | :------- | :---------- |
| channels | [FilterChannel](#filterchannel) | repeated | |
| next\_page\_token | string | | |
### GetChannelRequest
The request for a call to `ChannelService_GetChannel`.
| Field | Type | Label | Description |
| :---------- | :----- | :---- | :---------- |
| channel\_id | string | | |
### GetChannelResponse
The response of a call to `ChannelService_GetChannel`.
| Field | Type | Label | Description |
| :------ | :------------------ | :---- | :---------- |
| channel | [Channel](#channel) | | |
### ListChannelsRequest
The request for a call to `ChannelService_ListChannels` to retrieve channels.
| Field | Type | Label | Description |
| :---------- | :----- | :---- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| page\_size | uint32 | | The maximum number of channels to return. The service may return fewer than this value. If unspecified, at most 50 channels will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000. Optional. |
| page\_token | string | | A page token, received from a previous `ListChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChannels` must match the call that provided the page token. Optional. |
| filter | string | | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `channel_id`, `asset_id`, `name`, `description` `run_id`, `run_name`, `run_client_key`, `created_date`, `modified_date`, `created_by_user_id`, and `modified_by_user_id`. For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/channels#channel). Optional. |
| order\_by | string | | How to order the retrieved channels. Formatted as a comma-separated string i.e. "FIELD\_NAME\[ desc],...". Available fields to order\_by are `name`, `created_date` and `modified_date`, `active`. If left empty, items are ordered by `created_date` in ascending order (oldest-first). For more information about the format of this field, read [this](https://google.aip.dev/132#ordering) Example: "created\_date desc,modified\_date" |
### ListChannelsResponse
The result of a call to ChannelService\_ListChannels.
| Field | Type | Label | Description |
| :---------------- | :------------------ | :------- | :---------- |
| channels | [Channel](#channel) | repeated | |
| next\_page\_token | string | | |
### UpdateChannelRequest
The request for a call to ChannelService\_UpdateChannel.
| Field | Type | Label | Description |
| :----------- | :------------------------------------------------------ | :---- | :----------------------------------------------------------------------------------------------------------------------------------------- |
| channel | [Channel](#channel) | | |
| update\_mask | [google.protobuf.FieldMask](#google-protobuf-fieldmask) | | The list of fields to be updated. The fields available to be updated are `display_description`, `display_units`, `metadata`, and `active`. |
### UpdateChannelResponse
The result of a call to ChannelService\_UpdateChannel.
| Field | Type | Label | Description |
| :------ | :------------------ | :---- | :---------- |
| channel | [Channel](#channel) | | |
## Enums
*Allowed constant values used in message fields.*