Skip to main content

# kater dashboard inputs read

Shows the filter values and the tab you kept for a workspace's dashboard.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

Kater drops a kept filter or parameter that the workspace no longer declares, or whose value is no longer valid. It names each one it drops.

## Examples

```bash
# Show the filter values you kept for the ad_reporting dashboard
kater dashboard inputs read --request-file ad_reporting.json
```

## Arguments

<div class="cli-options">

| Argument | Description |
| --- | --- |
| `<path>` | Optional. In place of `--request-file`: the workspace, the query file or the chart file the request names. |

</div>

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-file <file>` | The workspace, as JSON, such as `ad_reporting.json`. Give `-` to read it from standard input. See [The request](#the-request). |

</div>

It also takes the [global options](https://kater.ai/docs/cli-reference/global-options/) `--json`, `--kater-root`, `--scope` and `--help`.

## The request

| Field | What it holds |
| --- | --- |
| `namespace` | The workspace, by its full `path`. |

```json title="ad_reporting.json"
{"namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}}
```

## What it shows

| Field | What it holds |
| --- | --- |
| `saved` | Whether you kept values for this workspace. |
| `inputs` | The parameter values in `parameters`, and the filters you turned on in `filters`. |
| `tab` | The tab you kept. When it no longer exists, the dashboard opens on its first tab. |
| `dropped` | The filters and parameters that Kater dropped. |

## See also

- [`kater dashboard inputs`](https://kater.ai/docs/cli-reference/dashboard/inputs/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Arguments
Options
The request
What it shows
See also

Kater CLI Present and share dashboard inputs

kater dashboard inputs read

Shows the filter values and the tab you kept for a workspace's dashboard.

Kater drops a kept filter or parameter that the workspace no longer declares, or whose value is no longer valid. It names each one it drops.

Examples

# Show the filter values you kept for the ad_reporting dashboard
kater dashboard inputs read --request-file ad_reporting.json

Arguments

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

Options

Option	Description
`--request-file <file>`	The workspace, as JSON, such as `ad_reporting.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

Field	What it holds
`namespace`	The workspace, by its full `path`.

{"namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}}

What it shows

Field	What it holds
`saved`	Whether you kept values for this workspace.
`inputs`	The parameter values in `parameters`, and the filters you turned on in `filters`.
`tab`	The tab you kept. When it no longer exists, the dashboard opens on its first tab.
`dropped`	The filters and parameters that Kater dropped.

See also