UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip insights looker-dashboards

Syntax and options for `uip insights looker-dashboards`, which lists the Looker-era Insights dashboards and mints a signed embed URL for one of them.

uip insights looker-dashboards reads the Looker-era Insights dashboards: the dashboards in the caller's personal, tenant, template, and organization folders. list shows the dashboards the session can see, and get-embed-url mints a signed embed URL that opens one of them.

These dashboards use their own ID space, separate from the Maestro process dashboards that uip insights dashboards manages. A Looker dashboard ID works only on uip insights looker-dashboards commands. A template dashboard has a <model>::<name> ID, and a saved dashboard has an all-digit ID.

Synopsis​

uip insights looker-dashboards list [--looker-folder <folder>] [-l <n>] [-o <n>]
uip insights looker-dashboards get-embed-url <dashboard> [--theme <theme>] [--localization <locale>]
uip insights looker-dashboards list [--looker-folder <folder>] [-l <n>] [-o <n>]
uip insights looker-dashboards get-embed-url <dashboard> [--theme <theme>] [--localization <locale>]

These commands honor the global options and the standard exit codes. They do not accept -t, --tenant — they use the tenant selected during uip login.

Note:

The commands need the Insights Portal service provisioned in the active tenant. On a tenant without it, they fail with ErrorCode: not_found and instructions that name the missing provisioning.

uip insights looker-dashboards list​

List the Looker-era dashboards this session can see, across its personal, tenant, template, and organization folders.

Options​

FlagDescription
--looker-folder <folder>Show only one folder: personal, tenant, templates, or organization. Any other value fails with exit code 3 before a request is sent.
-l, --limit <number>Maximum rows to return. Defaults to 50.
-o, --offset <number>Rows to skip before returning results.

The backend returns all four folders in one response, so pagination and the --looker-folder filter are client-side, and every --offset page repeats the whole backend request. The CLI sorts rows before slicing: by folder in the order personal, tenant, templates, organization, then by title, then by ID. Pagination.Total counts the filtered set.

The backend caches each folder for up to an hour, so a listed dashboard may already be deleted.

A folder can be missing from the result:

  • The personal folder is listed only for a session with the Insights Dashboard Edit permission whose Looker user has a personal folder. When either is missing, Instructions says the personal folder was omitted.
  • A tenant or organization folder that Insights has not provisioned for the tenant is reported in Instructions as omitted, which is different from an empty folder.

Example​

uip insights looker-dashboards list --looker-folder templates
uip insights looker-dashboards list --looker-folder templates

Data shape (--output json)​

The command returns Code: "InsightsLookerDashboardsList", a Data array, and Pagination. Each row has these fields:

FieldDescription
IdDashboard ID to pass to get-embed-url: all digits for a saved dashboard, <model>::<name> for a template.
TitleDashboard title.
Folderpersonal, tenant, templates, or organization.
OwnerNameName of the dashboard owner.
HasRoiExploretrue when the dashboard uses the ROI explore.
HasIntegrationModeltrue when the dashboard uses an integration model.
HasOrgScopetrue when the dashboard is organization-scoped.
HasUserAttrOrCustomFieldstrue when the dashboard uses user attributes or custom fields.

An empty Data array is a successful result. When --offset is past the last row, Data is empty and Instructions says how many rows exist.

uip insights looker-dashboards get-embed-url​

Mint a signed, single-user Looker embed URL for one dashboard, by title or by ID.

Arguments​

ArgumentDescription
<dashboard>Dashboard title, or its ID from looker-dashboards list. Required.

The CLI decides from the value whether it is an ID or a title:

  • A value that is all digits or contains :: is treated as an ID and sent as is.
  • Any other value is a title. The CLI lists the dashboards and matches the title exactly, including case, after trimming spaces at either end.
  • A title that no row carries fails with ErrorCode: not_found.
  • A title that more than one row shares fails with ErrorCode: invalid_argument and lists the matching IDs as <id> (<folder>).
  • A dashboard whose title looks like an ID is reachable only by its ID.

Options​

FlagDescription
--theme <theme>Theme the embedded dashboard renders with: light or dark. Defaults to light.
--localization <locale>Locale for the embedded dashboard, for example ja. Insights uses English for a locale it does not know, so an unlisted value is not an error.
Warning:

The URL is a credential: it carries the caller's identity in its query string and opens an embed session as that caller. Put it in an iframe or open it directly. Do not store, log, or share it, and request a new one for each page load.

The embed session is bounded by the Insights service, and the dashboard renders with the caller's own Insights permissions and folder visibility. Embedding a saved dashboard needs the tenant's Insights license in full mode; without it, only template dashboards embed.

Examples​

# Embed a template dashboard by ID
uip insights looker-dashboards get-embed-url "<model>::<name>"

# Embed a dashboard by title, in the dark theme and in Japanese
uip insights looker-dashboards get-embed-url "Process overview" --theme dark --localization ja
# Embed a template dashboard by ID
uip insights looker-dashboards get-embed-url "<model>::<name>"

# Embed a dashboard by title, in the dark theme and in Japanese
uip insights looker-dashboards get-embed-url "Process overview" --theme dark --localization ja

Data shape (--output json)​

{
  "Code": "InsightsLookerDashboardEmbedUrl",
  "Data": {
    "DashboardId": "<model>::<name>",
    "ResolvedFrom": "id",
    "Url": "<your-signed-embed-url>",
    "Theme": "light",
    "Localization": null,
    "FolderPermissionsSuccess": true
  }
}
{
  "Code": "InsightsLookerDashboardEmbedUrl",
  "Data": {
    "DashboardId": "<model>::<name>",
    "ResolvedFrom": "id",
    "Url": "<your-signed-embed-url>",
    "Theme": "light",
    "Localization": null,
    "FolderPermissionsSuccess": true
  }
}
FieldDescription
DashboardIdID of the embedded dashboard.
ResolvedFromid when <dashboard> was an ID, title when the CLI resolved a title.
UrlSigned embed URL. The URL appears only in this field, never in Message or Instructions.
ThemeTheme sent.
LocalizationLocale sent, or null.
FolderPermissionsSuccessfalse when Insights could not resolve folder-permission attributes before signing the URL. The embedded dashboard's folder visibility may then differ from the Insights app until the next request.

Failures​

FailureErrorCodeRetry
The dashboard is not one this session can embed: another user's personal dashboard, a dashboard deleted within the last hour, or a saved dashboard on a tenant whose Insights license is not in full modenot_foundRetryWillNotFix
The session lacks Insights Dashboard View or Edit, or, for an organization-scoped dashboard, organization administrator or viewerpermission_deniedRetryWillNotFix
Insights could not mint the URL, could not read the caller's Looker user, or Looker is unavailableserver_errorRetryLater

A not_found from the embed call does not mean the login expired, so it carries no uip login advice. Insights also answers this way when its own permission check fails for a transient reason. An ID that list showed and that answers not_found twice is unreachable.

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