> ## 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/v2/channels.proto

<a name="sift_channels_v2_channels-proto" />

<a name="sift_channels_v2_channels-proto-services" />

## 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. |

<a name="sift_channels_v2_channels-proto-messages" />

## Messages

*Data models used across requests/responses.*

### Channel

| Field                  | Type                                                                                      | Label    | Description |
| :--------------------- | :---------------------------------------------------------------------------------------- | :------- | :---------- |
| channel\_id            | string                                                                                    |          |             |
| name                   | string                                                                                    |          |             |
| component              | string                                                                                    |          |             |
| 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                                                                                    |          |             |
| organization\_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 |             |
| metadata               | [sift.metadata.v1.MetadataValue](#sift-metadata-v1-metadatavalue)                         | repeated |             |

### 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`, `component`, `description` `run_id`, `run_name`, `run_client_key`, `created_date`, and `modified_date`. 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). |
| organization\_id | string |       | This field is only required if your user belongs to multiple organizations.                                                                                                                                                                                                                                                                                                                                                          |
| 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 `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              |          |             |

<a name="sift_channels_v2_channels-proto-enums" />

## Enums

*Allowed constant values used in message fields.*