Skip to content

Query box card

The Query box card lets a dashboard reader change the active search for one entity type.

When to use it

Use it when readers need free-form Neops search with field suggestions and saved searches. Use Predefined Searches when the allowed choices should be curated by the dashboard author.

Live example

The Card Lab replaces autocomplete and saved-search reads with deterministic in-browser fixtures.

Open the Query box Card Lab in a new page

Requirements

Requirement Value
Dashboard types Standard and aggregation
Minimum size 4 columns by 1 row; maximum height is 1 row
Data The selected entity context
Backend capabilities Global field autocomplete and saved-search operations
Permissions Read access to the entity type; saved-search create/delete access for those actions

Configuration

The paths below are relative to cardConfig.data.

entityType

Property Value
Type string
Required Yes
Default No default
Values device, interface, client, or group

Selects which dashboard entity query the input reads and updates.

localCardFilter

Property Value
Type JMESPath expression
Required No
Default No filter
Values An expression returning an array

Filters the card’s subscribed entity data. If it removes every row from a non-empty result, the query control is replaced with a no-data message. This setting does not alter the query text applied to other cards.

Examples

Device query control

{
  "cardId": "query",
  "data": {
    "entityType": "device"
  }
}

Submitting text updates the dashboard’s card-query filter for devices.

Behavior

The input follows changes to the same dashboard filter, provides global fields, logical operators, and saved searches as suggestions, and submits without separate action buttons. Saving and deleting a saved query call the backend and show a notification on success.

Limitations and safety

The query affects every consumer of the selected entity context, not only this card. Saved-search actions persist user data on the backend.

Use Predefined Searches for fixed buttons or Query with predefined filters for a free-form query combined with curated filters.