> ## 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.
# panel_configuration
> sift/panel_configurations/v1/panel_configuration.proto
## Services
*RPC methods exposed by this API.*
### PanelConfigurationService
| Method | Request | Response | Description |
| :----------------------- | :------------------------------------------------------------------ | :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- |
| GetPanelConfiguration | [GetPanelConfigurationRequest](#getpanelconfigurationrequest) | [GetPanelConfigurationResponse](#getpanelconfigurationresponse) | Retrieves a panel configuration. |
| ListPanelConfigurations | [ListPanelConfigurationsRequest](#listpanelconfigurationsrequest) | [ListPanelConfigurationsResponse](#listpanelconfigurationsresponse) | Retrieves panel configurations using an optional filter. |
| CreatePanelConfiguration | [CreatePanelConfigurationRequest](#createpanelconfigurationrequest) | [CreatePanelConfigurationResponse](#createpanelconfigurationresponse) | Creates a panel configuration. |
| UpdatePanelConfiguration | [UpdatePanelConfigurationRequest](#updatepanelconfigurationrequest) | [UpdatePanelConfigurationResponse](#updatepanelconfigurationresponse) | Updates an existing panel configuration using using the list of fields specified in `update_mask`. |
## Messages
*Data models used across requests/responses.*
### ChannelConfigurations
| Field | Type | Label | Description |
| :------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------- | :------- | :--------------------------- |
| name | string | | |
| type | [PlottedChannelType](#plottedchanneltype) | | |
| color | string | | |
| channel\_settings | google.protobuf.Struct | | |
| bit\_field\_index | int32 | optional | bitfield |
| bit\_field\_element | [sift.common.type.v1.ChannelBitFieldElement](#sift-common-type-v1-channelbitfieldelement) | optional | |
| expression | string | optional | temporary calculated channel |
| expression\_channel\_references | [sift.calculated\_channels.v2.CalculatedChannelAbstractChannelReference](#sift-calculated_channels-v2-calculatedchannelabstractchannelreference) | repeated | |
| data\_type | [sift.common.type.v1.ChannelDataType](#sift-common-type-v1-channeldatatype) | optional | |
### CreatePanelConfigurationRequest
| Field | Type | Label | Description |
| :---------------------- | :---------------------------------------------------------------- | :------- | :---------- |
| name | string | | |
| channel\_configurations | [ChannelConfigurations](#channelconfigurations) | repeated | |
| chart\_settings | google.protobuf.Struct | optional | |
| metadata | [sift.metadata.v1.MetadataValue](#sift-metadata-v1-metadatavalue) | repeated | |
### CreatePanelConfigurationResponse
| Field | Type | Label | Description |
| :------------------- | :---------------------------------------- | :---- | :---------- |
| panel\_configuration | [PanelConfiguration](#panelconfiguration) | | |
### GetPanelConfigurationRequest
| Field | Type | Label | Description |
| :----------------------- | :----- | :---- | :---------- |
| panel\_configuration\_id | string | | |
### GetPanelConfigurationResponse
| Field | Type | Label | Description |
| :------------------- | :---------------------------------------- | :---- | :---------- |
| panel\_configuration | [PanelConfiguration](#panelconfiguration) | | |
### ListPanelConfigurationsRequest
| Field | Type | Label | Description |
| :---------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| page\_size | uint32 | | The maximum number of panel configurations to return. The service may return fewer than this value. If unspecified, at most 50 panel configurations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| page\_token | string | | A page token, received from a previous `ListPanelConfigurations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPanelConfigurations` must match the call that provided the page token. |
| filter | string | | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string Available fields to filter by are 'name', 'created\_date', 'modified\_date', 'is\_archived', and `metadata`. Metadata can be used in filters by using `metadata.{metadata_key_name}` as the field name. Folder membership is filterable via the `folders` and `activeFolders` fields. Both contain the ids of the folders the panel configuration belongs to; `activeFolders` excludes archived folders. Use `"" in folders` to return panel configurations in the given folder, and `size(activeFolders) == 0` to return uncategorized panel configurations (panel configurations whose only memberships are in archived folders count as uncategorized). 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). |
| order\_by | string | | How to order the retrieved panel configurations. Formatted as a comma-separated string i.e. "FIELD\_NAME\[ desc],...". Available fields to order\_by are `name`. If left empty, items are ordered by `name` in ascending order (alphabetical). For more information about the format of this field, read [this](https://google.aip.dev/132#ordering) Example: "name" |
| run\_ids | string | repeated | |
| asset\_ids | string | repeated | |
### ListPanelConfigurationsResponse
| Field | Type | Label | Description |
| :-------------------- | :---------------------------------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------- |
| panel\_configurations | [PanelConfiguration](#panelconfiguration) | repeated | |
| next\_page\_token | string | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
### PanelConfiguration
| Field | Type | Label | Description |
| :----------------------- | :---------------------------------------------------------------- | :------- | :------------------------------------------------------ |
| panel\_configuration\_id | string | | |
| version\_id | string | | |
| version | uint32 | | |
| change\_message | string | | |
| name | string | | |
| channel\_configurations | [ChannelConfigurations](#channelconfigurations) | repeated | |
| chart\_settings | google.protobuf.Struct | optional | |
| created\_date | google.protobuf.Timestamp | | |
| modified\_date | google.protobuf.Timestamp | | |
| archived\_date | google.protobuf.Timestamp | | |
| created\_by\_user\_id | string | | |
| modified\_by\_user\_id | string | | |
| is\_archived | bool | | |
| metadata | [sift.metadata.v1.MetadataValue](#sift-metadata-v1-metadatavalue) | repeated | |
| folder\_ids | string | repeated | Ids of the folders this panel configuration belongs to. |
### UpdatePanelConfigurationRequest
The request for a call to `PanelConfigurationService_UpdatePanelConfiguration` to update a panel configuration. Updating a panel
configuration creates a new version of the panel configuration, leaving the previous untouched. If no update is deemed necessary, then the
the current version is returned. Use `is_archived` to archive/unarchive a panel configuration.
| Field | Type | Label | Description |
| :------------------- | :------------------------------------------------------ | :---- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| panel\_configuration | [PanelConfiguration](#panelconfiguration) | | The panel configuration to update. |
| update\_mask | [google.protobuf.FieldMask](#google-protobuf-fieldmask) | | The list of fields to be updated. The fields available to be updated are `name`, `channel_configurations`, `chart_settings`, `is_archived`, and `metadata`. |
### UpdatePanelConfigurationResponse
| Field | Type | Label | Description |
| :------------------- | :---------------------------------------- | :---- | :---------- |
| panel\_configuration | [PanelConfiguration](#panelconfiguration) | | |
## Enums
*Allowed constant values used in message fields.*
### PlottedChannelType
| Name | Number | Description |
| :------------------------------------------ | :----- | :---------- |
| PLOTTED\_CHANNEL\_TYPE\_UNSPECIFIED | 0 | |
| PLOTTED\_CHANNEL\_TYPE\_REGULAR | 1 | |
| PLOTTED\_CHANNEL\_TYPE\_CALCULATED\_CHANNEL | 2 | |
| PLOTTED\_CHANNEL\_TYPE\_BIT\_FIELD\_ELEMENT | 3 | |
| PLOTTED\_CHANNEL\_TYPE\_ENUM | 4 | |