UiPath Documentation
uipath-cli
latest
false

UiPath CLI user guide

Last updated May 7, 2026

uip insights jobs

uip insights jobs exposes the preset Insights dashboards as CLI commands. Every subcommand posts to a dedicated Insights endpoint and returns the raw response in the standard Code/Data envelope. All seven subcommands share the same filter surface (time range, folders, processes, machines).

Synopsis​

uip insights jobs <verb> [options]
uip insights jobs <verb> [options]

Verbs​

VerbPurpose
summaryTotal job count, successful count, average processing time.
completed-timelineCompleted jobs over time, grouped by terminal state.
uncompleted-timelineUncompleted (running/pending) jobs over time.
top-failuresProcesses with the most job failures.
failures-by-reasonJob failures grouped by exception reason.
process-detailsPer-process job breakdown with counts by state.
failure-detailsDetailed failure rows for drill-down investigation.

Shared filters​

Every insights jobs subcommand accepts the same options:

FlagDescription
-t, --tenant <tenant-name>Tenant (optional, defaults to value selected during auth).
--time-range <minutes>Relative time range in minutes (e.g. 1440 for 1 day, 43200 for 30 days).
--started-after <epoch-ms>Absolute start time as Unix epoch milliseconds.
--started-before <epoch-ms>Absolute end time as Unix epoch milliseconds.
--folder-key <guid>Folder key filter (repeatable).
--process-name <name>Process name filter (repeatable).
--machine-name <name>Machine name filter (repeatable).
--timezone-offset <minutes>Client timezone offset in minutes from UTC.

Use either --time-range or the absolute --started-after/--started-before pair — combining them is valid but the Insights backend resolves to whichever interval is narrower. All filters are optional; an unfiltered query returns tenant-wide data for the default time range. --folder-key, --process-name, and --machine-name are repeatable — pass them multiple times to include several values.

Integer options (--time-range, --started-after, --started-before, --timezone-offset) are validated at parse time; a non-numeric value fails fast with a message naming the flag.

uip insights jobs summary​

Total job count, successful count, and average processing time.

Options​

Examples​

uip insights jobs summary --time-range 1440

uip insights jobs summary \
    --process-name Invoicing --process-name Payroll --time-range 43200

uip insights jobs summary --time-range 1440 \
    --output-filter 'Data.{total:TotalJobs, success:SuccessfulJobs}'
uip insights jobs summary --time-range 1440

uip insights jobs summary \
    --process-name Invoicing --process-name Payroll --time-range 43200

uip insights jobs summary --time-range 1440 \
    --output-filter 'Data.{total:TotalJobs, success:SuccessfulJobs}'

Response code: InsightsJobsSummary.

uip insights jobs completed-timeline​

Completed jobs over time, grouped by terminal job state.

Options​

Examples​

uip insights jobs completed-timeline --time-range 10080

uip insights jobs completed-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --time-range 1440 --timezone-offset -480

uip insights jobs completed-timeline \
    --started-after 1714003200000 --started-before 1714608000000
uip insights jobs completed-timeline --time-range 10080

uip insights jobs completed-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --time-range 1440 --timezone-offset -480

uip insights jobs completed-timeline \
    --started-after 1714003200000 --started-before 1714608000000

Response code: InsightsJobsCompletedTimeline.

uip insights jobs uncompleted-timeline​

Uncompleted (running/pending) jobs over time.

Options​

Examples​

uip insights jobs uncompleted-timeline --time-range 1440

uip insights jobs uncompleted-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000002

uip insights jobs uncompleted-timeline --time-range 1440 \
    --machine-name prod-worker-01
uip insights jobs uncompleted-timeline --time-range 1440

uip insights jobs uncompleted-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000002

uip insights jobs uncompleted-timeline --time-range 1440 \
    --machine-name prod-worker-01

Response code: InsightsJobsUncompletedTimeline.

uip insights jobs top-failures​

Processes with the most failures in the filter window.

Options​

Examples​

uip insights jobs top-failures --time-range 43200

uip insights jobs top-failures --time-range 10080 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs top-failures --time-range 43200 \
    --output-filter 'Data[].{process:ProcessName, count:FailureCount}'
uip insights jobs top-failures --time-range 43200

uip insights jobs top-failures --time-range 10080 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs top-failures --time-range 43200 \
    --output-filter 'Data[].{process:ProcessName, count:FailureCount}'

Response code: InsightsJobsTopFailures.

uip insights jobs failures-by-reason​

Job failures grouped by exception reason.

Options​

Examples​

uip insights jobs failures-by-reason --time-range 43200

uip insights jobs failures-by-reason --time-range 1440 \
    --process-name Invoicing

uip insights jobs failures-by-reason --time-range 10080 \
    --output-filter 'Data[].{reason:Reason, count:Count}'
uip insights jobs failures-by-reason --time-range 43200

uip insights jobs failures-by-reason --time-range 1440 \
    --process-name Invoicing

uip insights jobs failures-by-reason --time-range 10080 \
    --output-filter 'Data[].{reason:Reason, count:Count}'

Response code: InsightsJobsFailuresByReason.

uip insights jobs process-details​

Per-process job breakdown with counts by state.

Options​

Examples​

uip insights jobs process-details --process-name Invoicing --time-range 1440

uip insights jobs process-details --time-range 43200 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs process-details \
    --process-name Invoicing --process-name Payroll \
    --started-after 1714003200000 --started-before 1714608000000
uip insights jobs process-details --process-name Invoicing --time-range 1440

uip insights jobs process-details --time-range 43200 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs process-details \
    --process-name Invoicing --process-name Payroll \
    --started-after 1714003200000 --started-before 1714608000000

Response code: InsightsJobsProcessDetails.

uip insights jobs failure-details​

Detailed failure rows for drill-down investigation.

Options​

Examples​

uip insights jobs failure-details --process-name Invoicing --time-range 1440

uip insights jobs failure-details --time-range 10080 \
    --machine-name prod-worker-01

uip insights jobs failure-details --time-range 1440 \
    --output-filter 'Data[].{job:JobKey, reason:Reason, ts:StartTime}'
uip insights jobs failure-details --process-name Invoicing --time-range 1440

uip insights jobs failure-details --time-range 10080 \
    --machine-name prod-worker-01

uip insights jobs failure-details --time-range 1440 \
    --output-filter 'Data[].{job:JobKey, reason:Reason, ts:StartTime}'

Response code: InsightsJobsFailureDetails.

Data shape (--output json)​

All commands return the same envelope. The Data field carries the endpoint-specific Insights response — the inner structure differs per endpoint but the envelope is uniform.

{
  "Code": "InsightsJobsSummary",
  "Data": { "...": "endpoint-specific payload" }
}
{
  "Code": "InsightsJobsSummary",
  "Data": { "...": "endpoint-specific payload" }
}
Note:

The exact inner structure of each response variant is specified by the Insights API and is not enumerated here. Run the command once with --output json against a tenant with data to see the schema you will be consuming, and pin @uipath/cli in CI if you parse specific fields.

Error behavior​

  • Missing authentication. The CLI emits Failure with Instructions: "Run 'uip login' to authenticate first." and exits 1.
  • Backend errors (4xx/5xx from Insights). Failure with Instructions: "Check your authentication, tenant, and filter parameters." and exits 1.
  • uip insights — tool overview.
  • uip login — session used for every Insights call.
  • uip traces — LLM Observability spans, an orthogonal observability surface.

See also​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated