Skip to main content
On this page

Kater CLI Present and share dashboard tiles

kater dashboard tiles add

Puts a saved chart on a workspace's dashboard as a tile.

Without a place, the tile fills the first empty slot that fits it. When there is none, it goes after the last tile of the last section that holds tiles. Name a section, a place, or a tile to follow to put it somewhere else.

Examples

Terminal window
# Put the spend_by_platform chart on the ad_reporting dashboard
kater dashboard tiles add --request-file add_spend_by_platform.json
# Make a request that puts it in the Overview section, and send it
jq '.section = "overview"' add_spend_by_platform.json > add_spend_by_platform_overview.json
kater dashboard tiles add --request-file add_spend_by_platform_overview.json
# Make a request that puts it right after the spend_mix tile, and send it
jq '.after = "spend_mix"' add_spend_by_platform.json > add_spend_by_platform_after.json
kater dashboard tiles add --request-file add_spend_by_platform_after.json

Arguments

ArgumentDescription
<path>Optional. In place of --request-file: the workspace, the query file or the chart file the request names.

Options

OptionDescription
--request-file <file>The workspace, the chart and where its tile goes, as JSON. Give - to read it from standard input. See The request.

It also takes the global options --json, --kater-root, --scope and --help.

The request

FieldWhat it holds
namespaceThe workspace, by its full path.
chartThe saved chart, by its name, such as spend_by_platform.
tabOptional. The tab to put the tile on. A dashboard with tabs needs it.
sectionOptional. A section that the dashboard declares, such as overview.
atOptional. The tile’s place among the section’s tiles, from 0 for the first. It goes before the tile there now.
afterOptional. A chart on the dashboard that the tile follows: on its tab, in its section, at its size when the chart fits it. Give no slot, region, section or at with it.
slotOptional. The place in tiles of the empty slot to fill, from 0 for the first.
regionOptional. A region of the dashboard’s template other than tiles, such as kpis or aside.
expected_revisionOptional. The revision from kater dashboard open.
include_inputsOptional, true when you leave it out. False answers faster, without the workspace’s filters.
add_spend_by_platform.json
{"namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}, "chart": "spend_by_platform"}

When Kater refuses

  • The chart is already on the dashboard.
  • The chart is not saved. Save it first with kater new chart.
  • The section is not declared in dashboard.yaml.
  • The dashboard has tabs, and the request names no tab.

See also