leapview dashboards
Inspect dashboards
Usage
leapview dashboards [flags]
Machine-readable: JSON · Markdown
Options
| Flag |
Type |
Default |
Description |
-h, --help |
bool |
false |
help for dashboards |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |
Subcommands
describe: Describe a dashboard
export: Export a dashboard as expanded or fragmented YAML
filter: Describe a compiled dashboard filter binding
filter-options: List dashboard filter options
list: List dashboards
page: Describe a dashboard page
query-page: Query a dashboard page
visual: Describe a dashboard visual
visual-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 |
-h, --help |
bool |
false |
help for describe |
--project-id |
string |
`` |
target-bound Project identity |
--target |
string |
`` |
LeapView server URL |
--token |
string |
`` |
API token |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |
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 |
-h, --help |
bool |
false |
help for export |
--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 |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |
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 |
-h, --help |
bool |
false |
help for filter |
--project-id |
string |
`` |
target-bound Project identity |
--target |
string |
`` |
LeapView server URL |
--token |
string |
`` |
API token |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |
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 |
-h, --help |
bool |
false |
help for filter-options |
--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 |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |
list
List dashboards
Usage
leapview dashboards list [flags]
Behavior
| Side effect |
Confirmation |
read |
never |
Machine-readable: JSON · Markdown
Options
| Flag |
Type |
Default |
Description |
-h, --help |
bool |
false |
help for list |
--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 |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |
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 |
-h, --help |
bool |
false |
help for page |
--project-id |
string |
`` |
target-bound Project identity |
--target |
string |
`` |
LeapView server URL |
--token |
string |
`` |
API token |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |
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 |
-h, --help |
bool |
false |
help for query-page |
--project-id |
string |
`` |
target-bound Project identity |
--target |
string |
`` |
LeapView server URL |
--token |
string |
`` |
API token |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |
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 |
-h, --help |
bool |
false |
help for visual |
--project-id |
string |
`` |
target-bound Project identity |
--target |
string |
`` |
LeapView server URL |
--token |
string |
`` |
API token |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |
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 |
-h, --help |
bool |
false |
help for visual-data |
--project-id |
string |
`` |
target-bound Project identity |
--target |
string |
`` |
LeapView server URL |
--token |
string |
`` |
API token |
Inherited options
| Flag |
Type |
Default |
Description |
--no-input |
bool |
false |
disable terminal prompts and automatic browser opening |