- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip insights
Commands for querying UiPath Insights dashboards for job execution analytics using the `uip insights` tool.
uip insights queries UiPath Insights — the analytics layer over job, queue, and machine monitoring data, alerts, and the entities (folders, processes, queues, machines, users) that data is filtered by. The tool exposes preset Insights views and lookup lists as commands, manages the standalone dashboards of Maestro processes, and reads the organization's export configurations.
Install it with uip tools install insights, or invoke uip insights … and let auto-install run. The underlying package is @uipath/insights-tool; the command prefix is insights. See Tools (plugins) for the install model and uip tools for the command that manages tool installation.
Resources
| Resource | Purpose |
|---|---|
| jobs | Summary, completed- and uncompleted-job timelines, top failures, failures by reason, per-process breakdowns, and failure-detail drill-downs. |
| alerts | List configured alerts, get one by ID, check the tenant's alerting entitlement. |
| alert-history | List historical alert triggers and get alert metrics. |
| alert-deliveries | Get delivery detail for a single alert trigger. |
| users | List users, for filtering job and alert data by user. |
| roles | Read the Insights roles defined in the active tenant. |
| groups | Read the Insights groups of the active tenant and their role names. |
| filter-folders | List folders, for use with --folder-key filters. |
| filter-processes | List processes, for use with --process-name filters. |
| filter-machines | List machines, for use with --machine-name filters. |
| filter-queues | List queues. |
| dashboards | Read, create, update, delete, and copy the standalone monitoring dashboards of Maestro processes. |
| dashboard-filters | List the global filters stored with a standalone dashboard. |
| queues | Query queue monitoring data: item totals, SLA buckets, timelines, failures, details, and retry outcomes. |
| machines | Query machine monitoring data: runtime mix, details, availability intervals, failures, and utilization. |
| export-configurations | List the organization's unified export configurations and check their destinations. |
Synopsis
uip insights <resource> <verb> [options]
uip insights <resource> <verb> [options]
All uip insights verbs honor the global options (--output, --output-filter, --log-level, --log-file) and the standard exit codes. No resource takes a --tenant option — every verb always uses the tenant selected during uip login.
Shared filters (jobs)
Every insights jobs subcommand accepts the same filter surface — time range, folders, processes, machines. The flag set is documented inline on the jobs page.
A time range is required: pass --time-range, or both --started-after and --started-before together — supplying only one of the pair is treated as supplying neither. Combining --time-range with the absolute pair is valid; the Insights backend resolves to whichever interval is narrower. Every other filter is optional.
Authentication
Every Insights call uses the session established by uip login. If no session is present, the CLI emits Failure with Instructions: "Run 'uip login' to authenticate first." and exits 1.
See also
- Tools (plugins) — install, update, uninstall the
@uipath/insights-toolpackage. uip login— session used for every Insights call.uip traces— LLM Observability spans, an orthogonal observability surface.- Global options
- Exit codes