Telemetry
ayx telemetry surfaces operational data about your Alteryx One or Alteryx Server environment — what is running, what failed, how long things take, who has access to what. All commands are read-only. Backend is auto-detected from your profile; use --source one or --source server to override.
Quick reference
Section titled “Quick reference”| Command | What it does |
|---|---|
ayx telemetry summary |
One-shot overview across all telemetry surfaces |
ayx telemetry jobs running |
Jobs currently in Running or Queued state |
ayx telemetry jobs history |
Recent job history (succeeded, failed, cancelled) |
ayx telemetry jobs top |
Top flows by run count |
ayx telemetry workflows top |
Top workflows by run count, failure rate, or duration |
ayx telemetry workflows performance |
Per-workflow duration percentiles (p50/p95/p99) |
ayx telemetry workflows errors |
Workflows ordered by failure count |
ayx telemetry plans top |
Top plans by run count |
ayx telemetry plans performance |
Per-plan duration percentiles |
ayx telemetry errors recent |
Recent failed job groups with error messages |
ayx telemetry weekly run-counts |
168-bucket run-count matrix (7 days x 24 hours) |
ayx telemetry queue status |
Currently running and queued jobs (Server) |
ayx telemetry queue wait-time |
Wait-time stats for recent queue entries (Server) |
ayx telemetry permissions connections |
DCM connections and who has access |
ayx telemetry permissions workflows |
Who has workflow access |
ayx telemetry permissions collections |
Collection/Gallery ACLs (Server only) |
ayx telemetry permissions summary |
Access count rollup across subjects |
Getting a quick overview
Section titled “Getting a quick overview”Start here. The summary pulls from all surfaces and returns a single envelope:
ayx telemetry summary --profile prodControl the time window and result cap:
ayx telemetry summary --profile prod --since 24h --top 5--since accepts <N>h, <N>d, or <N>w. Default is 7d.
See what is running right now:
ayx telemetry jobs running --profile prodReview the last 24 hours of job history:
ayx telemetry jobs history --profile prod --since 24hFind the most-run flows over the past week:
ayx telemetry jobs top --profile prod --since 7d --top 10Workflow performance
Section titled “Workflow performance”Top workflows by run count:
ayx telemetry workflows top --profile prod --since 7dIdentify slow workflows using duration percentiles:
ayx telemetry workflows performance --profile prod --since 7dFind the most-failing workflows:
ayx telemetry workflows errors --profile prod --since 7dTop Alteryx One plans by run count:
ayx telemetry plans top --profile prod --since 7dPlan duration percentiles:
ayx telemetry plans performance --profile prod --since 7dRecent errors
Section titled “Recent errors”Pull recent failed job groups with their error messages:
ayx telemetry errors recent --profile prod --since 24hWeekly run pattern
Section titled “Weekly run pattern”Get the 168-bucket (7 days x 24 hours) run-count matrix. Useful for capacity planning and scheduling decisions:
ayx telemetry weekly run-counts --profile prodQueue depth (Server only)
Section titled “Queue depth (Server only)”The queue subcommand currently supports the Server backend only.
Check current queue depth:
ayx telemetry queue status --profile prod --source serverReview wait-time statistics:
ayx telemetry queue wait-time --profile prod --source serverPermissions
Section titled “Permissions”Audit who has access to what across your environment.
DCM connections and their authorized subjects:
ayx telemetry permissions connections --profile prodWorkflow access (workspace members on Alteryx One; collections on Alteryx Server):
ayx telemetry permissions workflows --profile prodGallery collection ACLs (Server only):
ayx telemetry permissions collections --profile prod --source serverAccess count summary per subject:
ayx telemetry permissions summary --profile prodPagination
Section titled “Pagination”Alteryx One list endpoints are paginated. Use --all to auto-paginate:
ayx telemetry workflows top --profile prod --allCap the number of pages with --max-pages <N> (default: 50):
ayx telemetry workflows top --profile prod --all --max-pages 20JSON output
Section titled “JSON output”All commands accept --output json as a global flag:
ayx --output json telemetry summary --profile prodThe envelope is always { ok, message, timestamp_utc, data } on success; failures also include error_code.