UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip insights dashboard-filters

Syntax and options for `uip insights dashboard-filters`, which lists the global filters stored with a standalone Insights dashboard.

uip insights dashboard-filters reads the global filters of a standalone Insights dashboard: the definition's filters array, not the per-chart filters.

Synopsis​

uip insights dashboard-filters list <dashboard-id> [--source-type <type>] [-l <n>] [-o <n>]
uip insights dashboard-filters list <dashboard-id> [--source-type <type>] [-l <n>] [-o <n>]

This command honors the global options and the standard exit codes.

uip insights dashboard-filters list​

List the global filters stored with one dashboard, in the order the definition stores them.

Arguments​

NameRequiredPurpose
<dashboard-id>yesNumeric dashboard ID or template-keyed UiPath- ID.

Options​

FlagDescription
--source-type <type>Source type of the dashboard. Default AO.
-l, --limit <number>Maximum rows to return. Defaults to 50.
-o, --offset <number>Rows to skip before returning results.

Pagination is client-side: every --offset page fetches the whole list again.

Example​

uip insights dashboard-filters list 644
uip insights dashboard-filters list 644

Data shape (--output json)​

The command returns Code: "InsightsDashboardFiltersList". Each row carries the members the filter has, among Type, Field, ValueType, Values, Invert, Pattern, SearchFilterType, and Range. Range holds Min, Max, Inclusive, and Preset when they are set.

An empty list is a successful result and not proof that the dashboard exists. A dashboard with no global filters, a template-keyed ID, and an unknown numeric ID all return an empty list. Confirm the ID with uip insights dashboards get <id>.

A source type that is not built in must be registered as a data model of the active tenant. Otherwise the command fails with not_found.

  • Synopsis​
  • uip insights dashboard-filters list​
  • Arguments​
  • Options​
  • Example​
  • Data shape (--output json)​
  • Related​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated