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

# views

> sift/views/v2/views.proto

<a name="sift_views_v2_views-proto" />

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

## Services

*RPC methods exposed by this API.*

### ViewService

| Method              | Request                                                   | Response                                                    | Description                                                                         |
| :------------------ | :-------------------------------------------------------- | :---------------------------------------------------------- | :---------------------------------------------------------------------------------- |
| GetView             | [GetViewRequest](#getviewrequest)                         | [GetViewResponse](#getviewresponse)                         | Retrieves a view.                                                                   |
| CreateView          | [CreateViewRequest](#createviewrequest)                   | [CreateViewResponse](#createviewresponse)                   | Creates a view.                                                                     |
| UpdateView          | [UpdateViewRequest](#updateviewrequest)                   | [UpdateViewResponse](#updateviewresponse)                   | Updates an existing view using using the list of fields specified in `update_mask`. |
| ListViews           | [ListViewsRequest](#listviewsrequest)                     | [ListViewsResponse](#listviewsresponse)                     | Retrieves views using an optional filter.                                           |
| ListApplicableViews | [ListApplicableViewsRequest](#listapplicableviewsrequest) | [ListApplicableViewsResponse](#listapplicableviewsresponse) | Lists views that apply to assets/runs.                                              |
| DeleteView          | [DeleteViewRequest](#deleteviewrequest)                   | [DeleteViewResponse](#deleteviewresponse)                   | Deletes a view.                                                                     |
| PinView             | [PinViewRequest](#pinviewrequest)                         | [PinViewResponse](#pinviewresponse)                         | Pins a view.                                                                        |
| UnpinView           | [UnpinViewRequest](#unpinviewrequest)                     | [UnpinViewResponse](#unpinviewresponse)                     | Unpins a view.                                                                      |

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

## Messages

*Data models used across requests/responses.*

### CreateViewRequest

| Field | Type          | Label | Description |
| :---- | :------------ | :---- | :---------- |
| view  | [View](#view) |       |             |

### CreateViewResponse

| Field | Type          | Label | Description |
| :---- | :------------ | :---- | :---------- |
| view  | [View](#view) |       |             |

### DeleteViewRequest

| Field    | Type   | Label | Description |
| :------- | :----- | :---- | :---------- |
| view\_id | string |       |             |

### DeleteViewResponse

*This message has no fields.*

### GetViewRequest

| Field    | Type   | Label | Description |
| :------- | :----- | :---- | :---------- |
| view\_id | string |       |             |

### GetViewResponse

| Field | Type          | Label | Description |
| :---- | :------------ | :---- | :---------- |
| view  | [View](#view) |       |             |

### ListApplicableViewsRequest

| Field       | Type   | Label    | Description                                                                                                                                                                                                                                |
| :---------- | :----- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| page\_size  | uint32 |          | The maximum number of views to return. The service may return fewer than this value. If unspecified, at most 50 views 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 `ListApplicableViews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApplicableViews` must match the call that provided the page token. |
| asset\_ids  | string | repeated |                                                                                                                                                                                                                                            |
| run\_ids    | string | repeated |                                                                                                                                                                                                                                            |

### ListApplicableViewsResponse

| Field             | Type          | Label    | Description                                                                                                                    |
| :---------------- | :------------ | :------- | :----------------------------------------------------------------------------------------------------------------------------- |
| views             | [View](#view) | 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. |

### ListViewsRequest

| Field       | Type   | Label | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| :---------- | :----- | :---- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| page\_size  | uint32 |       | The maximum number of views to return. The service may return fewer than this value. If unspecified, at most 50 views 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 `ListViews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListViews` 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', 'createdDate', and 'modifiedDate'. 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/views#view). Optional. |

### ListViewsResponse

| Field             | Type          | Label    | Description                                                                                                                    |
| :---------------- | :------------ | :------- | :----------------------------------------------------------------------------------------------------------------------------- |
| views             | [View](#view) | 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. |

### PinViewRequest

| Field    | Type   | Label | Description |
| :------- | :----- | :---- | :---------- |
| view\_id | string |       |             |

### PinViewResponse

*This message has no fields.*

### UnpinViewRequest

| Field    | Type   | Label | Description |
| :------- | :----- | :---- | :---------- |
| view\_id | string |       |             |

### UnpinViewResponse

*This message has no fields.*

### UpdateViewRequest

| Field        | Type                                                    | Label | Description                   |
| :----------- | :------------------------------------------------------ | :---- | :---------------------------- |
| view         | [View](#view)                                           |       |                               |
| update\_mask | [google.protobuf.FieldMask](#google-protobuf-fieldmask) |       | The list of fields to update. |

### UpdateViewResponse

| Field | Type          | Label | Description |
| :---- | :------------ | :---- | :---------- |
| view  | [View](#view) |       |             |

### View

| Field                  | Type                                | Label    | Description |
| :--------------------- | :---------------------------------- | :------- | :---------- |
| view\_id               | string                              |          |             |
| name                   | string                              |          |             |
| axis\_groups           | [View.AxisGroups](#view-axisgroups) |          |             |
| channels               | [View.Channel](#view-channel)       | repeated |             |
| created\_date          | google.protobuf.Timestamp           |          |             |
| modified\_date         | google.protobuf.Timestamp           |          |             |
| created\_by\_user\_id  | string                              |          |             |
| modified\_by\_user\_id | string                              |          |             |
| is\_pinned             | bool                                |          |             |

### View\.AxisGroups

| Field | Type   | Label    | Description |
| :---- | :----- | :------- | :---------- |
| left  | string | repeated |             |
| right | string | repeated |             |

### View\.Channel

| Field                       | Type                                                                          | Label    | Description |
| :-------------------------- | :---------------------------------------------------------------------------- | :------- | :---------- |
| name                        | string                                                                        |          |             |
| data\_type                  | string                                                                        |          |             |
| axis\_group                 | string                                                                        |          |             |
| bit\_field\_names           | string                                                                        | repeated |             |
| calculated\_channel\_config | [View.Channel.CalculatedChannelConfig](#view-channel-calculatedchannelconfig) | optional |             |

### View\.Channel.CalculatedChannelConfig

| Field               | Type                                                                                                                        | Label    | Description |
| :------------------ | :-------------------------------------------------------------------------------------------------------------------------- | :------- | :---------- |
| channel\_key        | string                                                                                                                      |          |             |
| channel\_references | [View.Channel.CalculatedChannelConfig.ChannelReferencesEntry](#view-channel-calculatedchannelconfig-channelreferencesentry) | repeated |             |
| expression          | string                                                                                                                      |          |             |
| unit                | string                                                                                                                      |          |             |

### View\.Channel.CalculatedChannelConfig.ChannelReferencesEntry

| Field | Type   | Label | Description |
| :---- | :----- | :---- | :---------- |
| key   | string |       |             |
| value | string |       |             |

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

## Enums

*Allowed constant values used in message fields.*