API DocsRESTView service

ListViews

Retrieves views using an optional filter.

GET
/api/v1/views

Query Parameters

pageSizeinteger

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.

Format: "int64"

pageTokenstring

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.

filterstring

A Common Expression Language (CEL) 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. For more information about the fields used for filtering, please refer to this definition. Optional.

curl -X GET "<API_URL>/api/v1/views?pageSize=0&pageToken=string&filter=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "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": {
              "property1": {
                "name": "string",
                "component": "string"
              },
              "property2": {
                "name": "string",
                "component": "string"
              }
            },
            "expression": "string",
            "unit": "string"
          }
        }
      ],
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "organizationId": "string",
      "modifiedByUserId": "string",
      "isPinned": true
    }
  ],
  "nextPageToken": "string"
}

Previous

Lists views that apply to assets/runs. GET

Next

PinView PATCH