Skip to main content
GET
/
api
/
v1
/
views:applicable
Lists views that apply to assets/runs.
curl --request GET \
  --url https://your-sift-api-url.com/api/v1/views:applicable \
  --header 'Authorization: Bearer <token>'
{
  "views": [
    {
      "viewId": "<string>",
      "name": "<string>",
      "axisGroups": {
        "left": [
          "<string>"
        ],
        "right": [
          "<string>"
        ]
      },
      "channels": [
        {
          "name": "<string>",
          "component": "<string>",
          "dataType": "<string>",
          "axisGroup": "<string>",
          "bitFieldNames": [
            "<string>"
          ],
          "calculatedChannelConfig": {
            "channelKey": "<string>",
            "channelReferences": {},
            "expression": "<string>",
            "unit": "<string>"
          }
        }
      ],
      "createdDate": "2023-11-07T05:31:56Z",
      "modifiedDate": "2023-11-07T05:31:56Z",
      "createdByUserId": "<string>",
      "organizationId": "<string>",
      "modifiedByUserId": "<string>",
      "isPinned": true
    }
  ],
  "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<int64>

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.

​
pageToken
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.

​
assetIds
string[]
​
runIds
string[]

Response

A successful response.

​
views
object[]
​
nextPageToken
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.