Any DQL query you write inside a document — a table's dqlQuery, a chart's dqlQuery, a filter's suggestion query, a condition-context query, and so on — can contain variables: placeholders that UA replaces with runtime values before the query runs. This lets one document adapt to whichever entity, timeframe, row, or filter selection the user is looking at.
The syntax is $(<VARIABLE_KEY>), for example,
smartscapeNodes "HOST" | filter id == toSmartscapeId($(nodeId))
At runtime $(nodeId) is replaced with the current entity's node ID, so the query fetches exactly the host the user opened.
Most variables come already quoted where a DQL string literal is expected. Variants prefixed with unquoted give the raw value for cases where you supply the quotes yourself.
Available in Entity Details and in any card bound to a single entity.
| Variable | Description | Example |
|---|---|---|
| Effective entity ID — the Smartscape node ID when present, otherwise the classic entity (ME) ID. |
|
| Smartscape node ID of the current entity. |
|
| Classic entity (ME) ID only — use when a query must use the classic ID even though a node ID is available. |
|
| Same as |
|
Available everywhere. The current timeframe follows the app's timeframe selector.
| Variable | Description | Example |
|---|---|---|
| Start of the current timeframe. |
|
| End of the current timeframe. |
|
| Preset timeframe for recent last-value entity data. |
|
| Preset timeframe for data that must be aggregated over an interval. |
|
| Preset timeframe for recent timeseries data. |
|
| Preset timeframe (6 h 10 min) for Davis events. |
|
Available in a chart's dqlQuery when the corresponding selector is configured on the chart.
| Variable | Description | Example |
|---|---|---|
| Currently selected chart aggregation. |
|
| Currently selected gauge aggregation. |
|
| Currently selected rollup. |
|
Available in a table's expandable-row content. They resolve to data from the row being expanded.
| Variable | Description | Example |
|---|---|---|
|
|
|
| Same as |
|
| Any row field via bracket notation; supports nested objects and arrays. |
|
$(row[<PATH>]) gives full access to the row, including nested objects and arrays. Given a row:
{ "id": "SERVICE-123", "count": 42, "entity": { "type": "SERVICE", "tags": ["production"] } }
$(row[id]) → SERVICE-123$(row[count]) → 42 (stringified)$(row[entity][type]) → SERVICE$(row[entity][tags][0]) → productionAvailable in filter suggestion queries and in DQL Table base queries that participate in filtering.
| Variable | Description | Example |
|---|---|---|
| The user's current search term, in value-suggestion queries. |
|
| The selected filter value. |
|
| The filter key (key-value filters only). |
|
| Replaced with |
|
| Comma-prefixed expression of all filters marked |
|
| Same as above but with |
|
| Comma-separated field IDs for a |
|
| Same as above but with a leading |
|
Available in health-alert action payloads and links.
| Variable | Description | Example |
|---|---|---|
| Health-alert event field via bracket notation; supports nested objects and arrays. |
|
| Variable | Description | Example |
|---|---|---|
| Dynamic sampling ratio value for the table's query. |
|
Variables produced by a document's conditionContext are a separate channel used only to decide whether an element is shown. They are not available for $(...) interpolation inside element DQL queries. See Conditional rendering.
An app hosting UA may define its own custom variables in addition to the built-in ones above. If you see a $(...) placeholder in an app's own examples that isn't listed here, it is likely one of those app-supplied variables rather than a built-in one.
ExtensionsInfrastructure Observability