Skip to main content

# kater insight scan

Finds the key takeaways of a workspace query, as a dashboard shows them.

{/* 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 runs each insight template that the query allows, with the template's columns matched to the query's fields. It writes nothing.

## Examples

```bash
# Find the takeaways of the spend_by_platform query
kater insight scan --request-file scan_spend_by_platform.json
# Make a request that runs the query on the warehouse again first, and send it
jq '.fresh = true' scan_spend_by_platform.json > scan_spend_by_platform_fresh.json
kater insight scan --request-file scan_spend_by_platform_fresh.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 query, as 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`. |
| `query` | The query, by its name, such as `spend_by_platform`. |
| `inputs` | Optional. The query's parameter values and filters. |
| `fresh` | Optional. True runs the query on the warehouse again. |

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

## What it shows

The answer has one takeaway for each template the query allows, in this order: `current_vs_prior`, `actual_vs_target`, `segment_vs_benchmark`, `mix_shift`, `trend_change`, `trend_volatility`, `top_bottom_gap`, `largest_segment`, `outlier_detection` and `threshold_breach`. A template that fails gives its `problem`, and the other takeaways still show. The query must be in a workspace, and you need permission to run it. The query's own optional filters are on.

## See also

- [`kater insight`](https://kater.ai/docs/cli-reference/insight/)
- [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 insight

kater insight scan

Finds the key takeaways of a workspace query, as a dashboard shows them.

Kater runs each insight template that the query allows, with the template’s columns matched to the query’s fields. It writes nothing.

Examples

# Find the takeaways of the spend_by_platform query
kater insight scan --request-file scan_spend_by_platform.json
# Make a request that runs the query on the warehouse again first, and send it
jq '.fresh = true' scan_spend_by_platform.json > scan_spend_by_platform_fresh.json
kater insight scan --request-file scan_spend_by_platform_fresh.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 query, 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

Field	What it holds
`namespace`	The workspace, by its full `path`.
`query`	The query, by its name, such as `spend_by_platform`.
`inputs`	Optional. The query’s parameter values and filters.
`fresh`	Optional. True runs the query on the warehouse again.

{"namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}, "query": "spend_by_platform"}

What it shows

The answer has one takeaway for each template the query allows, in this order: current_vs_prior, actual_vs_target, segment_vs_benchmark, mix_shift, trend_change, trend_volatility, top_bottom_gap, largest_segment, outlier_detection and threshold_breach. A template that fails gives its problem, and the other takeaways still show. The query must be in a workspace, and you need permission to run it. The query’s own optional filters are on.

See also