leapview dashboards
Inspect dashboards
Usage
leapview dashboards
Machine-readable: JSON · Markdown
Subcommands
describe: Describe a dashboardexport: Export a dashboard as expanded or fragmented YAMLfilter: Describe a compiled dashboard filter bindingfilter-options: List dashboard filter optionslist: List dashboardspage: Describe a dashboard pagequery-page: Query a dashboard pagevisual: Describe a dashboard visualvisual-data: Query dashboard visual data
describe
Describe a dashboard
Usage
leapview dashboards describe <dashboard> [flags]
Behavior
| Side effect | Confirmation |
|---|---|
read |
never |
Machine-readable: JSON · Markdown
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--project-id |
string | `` | target-bound Project identity |
--target |
string | `` | LeapView server URL |
--token |
string | `` | API token |
export
Export a dashboard as expanded or fragmented YAML
Usage
leapview dashboards export <dashboard> [flags]
Behavior
| Side effect | Confirmation |
|---|---|
local-write |
never |
Machine-readable: JSON · Markdown
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--layout |
string | expanded |
dashboard export layout: expanded or fragmented |
--out |
string | `` | expanded output file or empty fragmented output directory |
--source-root |
string | dashboards |
analytics source root |
filter
Describe a compiled dashboard filter binding
Usage
leapview dashboards filter <dashboard> <page> <filter> [flags]
Behavior
| Side effect | Confirmation |
|---|---|
read |
never |
Machine-readable: JSON · Markdown
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--project-id |
string | `` | target-bound Project identity |
--target |
string | `` | LeapView server URL |
--token |
string | `` | API token |
filter-options
List dashboard filter options
Usage
leapview dashboards filter-options <dashboard> <page> <filter> [flags]
Behavior
| Side effect | Confirmation |
|---|---|
read |
never |
Machine-readable: JSON · Markdown
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--filter-state-json |
string | `` | versioned dashboard filter state JSON |
--limit |
int | 0 |
maximum items to return (1-200) |
--page-token |
string | `` | opaque page token |
--project-id |
string | `` | target-bound Project identity |
--target |
string | `` | LeapView server URL |
--token |
string | `` | API token |
list
List dashboards
Usage
leapview dashboards list [flags]
Behavior
| Side effect | Confirmation |
|---|---|
read |
never |
Machine-readable: JSON · Markdown
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--limit |
int | 0 |
maximum items to return (1-200) |
--page-token |
string | `` | opaque page token |
--project-id |
string | `` | target-bound Project identity |
--target |
string | `` | LeapView server URL |
--token |
string | `` | API token |
page
Describe a dashboard page
Usage
leapview dashboards page <dashboard> <page> [flags]
Behavior
| Side effect | Confirmation |
|---|---|
read |
never |
Machine-readable: JSON · Markdown
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--project-id |
string | `` | target-bound Project identity |
--target |
string | `` | LeapView server URL |
--token |
string | `` | API token |
query-page
Query a dashboard page
Usage
leapview dashboards query-page <dashboard> <page> [flags]
Behavior
| Side effect | Confirmation |
|---|---|
read |
never |
Machine-readable: JSON · Markdown
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--filter-state-json |
string | `` | versioned dashboard filter state JSON |
--project-id |
string | `` | target-bound Project identity |
--target |
string | `` | LeapView server URL |
--token |
string | `` | API token |
visual
Describe a dashboard visual
Usage
leapview dashboards visual <dashboard> <page> <visual> [flags]
Behavior
| Side effect | Confirmation |
|---|---|
read |
never |
Machine-readable: JSON · Markdown
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--project-id |
string | `` | target-bound Project identity |
--target |
string | `` | LeapView server URL |
--token |
string | `` | API token |
visual-data
Query dashboard visual data
Usage
leapview dashboards visual-data <dashboard> <page> <visual> [flags]
Behavior
| Side effect | Confirmation |
|---|---|
read |
never |
Machine-readable: JSON · Markdown
Options
| Flag | Type | Default | Description |
|---|---|---|---|
--count |
int | 0 |
row count for table, matrix, or pivot visuals |
--filter-state-json |
string | `` | versioned dashboard filter state JSON |
--project-id |
string | `` | target-bound Project identity |
--target |
string | `` | LeapView server URL |
--token |
string | `` | API token |