UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip insights alert-history

Syntax and options for `uip insights alert-history`, which reads UiPath Insights alert trigger history and per-interval trigger-count metrics.

uip insights alert-history reads when alerts fired — trigger rows and aggregated trigger-count metrics — as opposed to alerts, which reads how alerts are defined.

Note:

These routes are feature-gated to Cloud and Dedicated SaaS deployments. On other deployment types the command fails with a ConfigError stating the routes aren't served, rather than an empty result.

Synopsis​

uip insights alert-history list [--time-range <minutes> | --since <epoch-seconds> [--until <epoch-seconds>]] [--alert-name <name>] [--folder-name <names...>] [--severity <severities...>] [-l <n>] [-o <n>]
uip insights alert-history get-metrics [--time-range <minutes> | --since <epoch-seconds> [--until <epoch-seconds>]] [--alert-name <name>] [--folder-name <names...>] [--severity <severities...>] --time-grouping <size>
uip insights alert-history list [--time-range <minutes> | --since <epoch-seconds> [--until <epoch-seconds>]] [--alert-name <name>] [--folder-name <names...>] [--severity <severities...>] [-l <n>] [-o <n>]
uip insights alert-history get-metrics [--time-range <minutes> | --since <epoch-seconds> [--until <epoch-seconds>]] [--alert-name <name>] [--folder-name <names...>] [--severity <severities...>] --time-grouping <size>

All verbs honor the global options and the standard exit codes. Neither verb accepts -t, --tenant — they use the tenant selected during uip login.

Shared filters​

Both verbs accept the same filter set:

FlagDescription
--time-range <minutes>Relative window ending now, in minutes. Mutually exclusive in effect with --since/--until — see below.
--since <epoch-seconds>Absolute lower bound, Unix epoch seconds (not milliseconds — jobs uses milliseconds).
--until <epoch-seconds>Absolute upper bound, Unix epoch seconds. Only meaningful with --since.
--alert-name <name>Filter to one alert name. Must not be empty.
--folder-name <names...>Filter by folder name (not folder key), space-separated/repeatable.
--severity <severities...>Filter by severity, space-separated/repeatable: INFO, WARN, ERROR, NORMAL (NORMAL is kept only for backward compatibility).

A time selection is required: pass --time-range, or --since (optionally with --until). Passing neither fails validation. --since 0/absent --since with only --until set both float to the oldest retrievable timestamp rather than being rejected.

Important:

list caps at the newest 1000 rows server-side (ORDER BY Timestamp DESC LIMIT 1000) — this is invisible in the payload itself. When exactly 1000 rows are returned, the response's Instructions field carries a truncation note: the true count may be larger and unknown. Narrow --time-range/--since+--until or add filters to stay under the cap rather than trusting a returned count of 1000 as exact.

uip insights alert-history list​

List alert trigger history rows in a time window, newest first.

Options​

See Shared filters, plus:

FlagDescription
-l, --limit <number>Maximum rows to return. Defaults to 50.
-o, --offset <number>Rows to skip before returning results.

Pagination is client-side over the (up to 1000-row) backend response.

Examples​

uip insights alert-history list --time-range 1440

uip insights alert-history list \
  --since 1714003200 --until 1714608000 \
  --severity ERROR WARN
uip insights alert-history list --time-range 1440

uip insights alert-history list \
  --since 1714003200 --until 1714608000 \
  --severity ERROR WARN

Data shape​

{
  "Code": "InsightsAlertHistoryList",
  "Data": [
    {
      "alertId": 42,
      "alertName": "High failure rate",
      "triggeredAt": 1714003200,
      "severity": "ERROR",
      "operator": "GreaterThan",
      "threshold": 5,
      "metric": "FailedJobCount",
      "metricState": "Failed",
      "deliveryId": 7
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "Total": 1, "HasMore": false }
}
{
  "Code": "InsightsAlertHistoryList",
  "Data": [
    {
      "alertId": 42,
      "alertName": "High failure rate",
      "triggeredAt": 1714003200,
      "severity": "ERROR",
      "operator": "GreaterThan",
      "threshold": 5,
      "metric": "FailedJobCount",
      "metricState": "Failed",
      "deliveryId": 7
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "Total": 1, "HasMore": false }
}

triggeredAt is Unix epoch seconds — the same unit as --since/--until, unlike jobs' millisecond fields. Under --folder-name, the backend can emit the same trigger once per matched folder, so identical-looking rows can be real, distinct events rather than duplicates.

uip insights alert-history get-metrics​

Get alert trigger counts per time interval, grouped by alert type.

Options​

See Shared filters, plus:

FlagDescription
--time-grouping <size>Required. Bucket size for the metric intervals.

Example​

uip insights alert-history get-metrics --time-range 10080 --time-grouping day
uip insights alert-history get-metrics --time-range 10080 --time-grouping day

Data shape​

{
  "Code": "InsightsAlertHistoryMetrics",
  "Data": {
    "groups": ["High failure rate", "SLA breach"],
    "intervalEndTimes": [1714003200, 1714089600],
    "counts": [[2, 5], [0, 1]]
  }
}
{
  "Code": "InsightsAlertHistoryMetrics",
  "Data": {
    "groups": ["High failure rate", "SLA breach"],
    "intervalEndTimes": [1714003200, 1714089600],
    "counts": [[2, 5], [0, 1]]
  }
}

Results are grouped by alert type: counts holds one row of trigger counts per entry in groups, and each count pairs with the interval end time at the same index in intervalEndTimes.

  • alerts — the alert definitions these triggers reference.
  • alert-deliveries — where a trigger's notification (deliveryId) was sent.

See also​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated