Skip to content

Status Overview card

The Status Overview card derives a headline state and an expandable list of per-entity status details.

When to use it

Use it when readers need both an overall health signal and the individual records behind that result. Use Status for proportional counts without per-record details.

Live example

The Card Lab evaluates the production card against deterministic interface records.

Open the Status Overview Card Lab in a new page

Requirements

Requirement Value
Dashboard types Standard
Minimum size 2 columns by 2 rows
Data Entity rows from one dashboard context
Backend capabilities Entity search for the selected type
Permissions Read access to every field used by the expressions and details

Configuration

The paths below are relative to cardConfig.data.

title

Property Value
Type Interpolated string
Required No
Default no title provided
Values Text with {{ expression }} tokens evaluated against the entity array

Sets the card heading.

entityType

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

Selects the source collection.

localCardFilter

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

Filters only this card before every status expression is evaluated. This inherited expert field is not shown in the guided form.

mainStatus

Property Value
Type Object
Required No
Default Derived from minor states, with error taking precedence over warning and success
Values One condition, status, and tooltip

Defines an explicit overall status. When omitted, the card derives the worst state from the generated detail rows.

mainStatus.jmesCondition

Property Value
Type JMESPath expression
Required For an explicit main status
Default No explicit main status
Values Expression evaluated against the filtered entity array

Any non-empty result activates mainStatus.status. An empty result produces an error state with the tooltip Main status condition not met.

mainStatus.status

Property Value
Type string
Required No
Default Runtime fallback: error
Values success, warn, or error

Chooses the headline color and icon.

mainStatus.tooltip

Property Value
Type string
Required No
Default No tooltip
Values Plain text

Explains the headline icon on hover.

mapping

Property Value
Type Array of objects
Required For detail rows and automatic status
Default Empty array
Values Status rules evaluated in array order

Each rule may yield multiple entities, producing one detail row per result.

mapping[].type

Property Value
Type string
Required No
Default Runtime fallback: error
Values success, warn, or error

Sets the state for rows created by this rule.

mapping[].jmesCondition

Property Value
Type JMESPath expression
Required No
Default Produces no rows
Values Expression returning an array of matched entities

Selects the records represented by this rule.

mapping[].labelJmesPath

Property Value
Type JMESPath expression
Required No
Default No label
Values Expression evaluated against each matched entity

Sets each detail row’s label.

mapping[].markDownDescriptionText

Property Value
Type Markdown string
Required No
Default No description
Values Markdown shown for every row produced by this rule

Provides the short status description.

mapping[].markDownContextJmesPath

Property Value
Type JMESPath expression
Required No
Default Empty details context
Values Expression returning an object or string from each matched entity

Selects the interpolation context for expanded detail Markdown. Other result types are rejected and leave the details empty.

mapping[].markDownDropdownDetailsText

Property Value
Type Markdown string with interpolation
Required No
Default Empty expanded detail
Values Markdown evaluated against the selected detail context

Defines the content shown when a reader expands a detail row.

Examples

Interface health details

{
  "cardId": "status-overview",
  "data": {
    "title": "Interface health",
    "entityType": "interface",
    "mapping": [
      {
        "type": "success",
        "jmesCondition": "[?state == 'UP']",
        "labelJmesPath": "name",
        "markDownDescriptionText": "Interface is up"
      },
      {
        "type": "error",
        "jmesCondition": "[?state == 'DOWN']",
        "labelJmesPath": "name",
        "markDownDescriptionText": "Interface is down"
      }
    ]
  }
}

The headline is derived from the rows: any down interface makes it an error; otherwise all-up results are successful.

Behavior

The card shows one headline color bar and icon. The details button opens a modal containing all rows generated by the mapping rules. Loading uses a skeleton; a local filter that removes every source row replaces the card with a filter message.

Limitations and safety

Overlapping conditions create multiple rows for the same entity. Markdown details can expose any readable field selected into their context.

See Status for grouped proportions.