Skip to main content
GET
/
api
/
v1
/
panel-configurations
ListPanelConfigurations
curl --request GET \
  --url https://your-sift-api-url.com/api/v1/panel-configurations \
  --header 'Authorization: Bearer <token>'
{
  "panelConfigurations": [
    {
      "panelConfigurationId": "<string>",
      "versionId": "<string>",
      "version": 123,
      "changeMessage": "<string>",
      "name": "<string>",
      "panelType": "PANEL_TYPE_UNSPECIFIED",
      "channelConfigurations": [
        {
          "name": "<string>",
          "type": "PLOTTED_CHANNEL_TYPE_UNSPECIFIED",
          "color": "<string>",
          "channelSettings": {},
          "bitFieldIndex": 123,
          "bitFieldElement": {
            "name": "<string>",
            "index": 123,
            "bitCount": 123
          },
          "expression": "<string>",
          "expressionChannelReferences": [
            "<string>"
          ]
        }
      ],
      "chartSettings": {},
      "createdDate": "2023-11-07T05:31:56Z",
      "modifiedDate": "2023-11-07T05:31:56Z",
      "archivedDate": "2023-11-07T05:31:56Z",
      "createdByUserId": "<string>",
      "modifiedByUserId": "<string>"
    }
  ],
  "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

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.

​
pageToken
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) filter string Available fields to filter by are 'name', 'created_date', and 'modified_date'. For further information about how to use CELs, please refer to this guide.

​
orderBy
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 Example: "name"

Response

A successful response.

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