Skip to content

Results & publications

After a Job Library entry runs, Alteryx One stores profile data, tabular results, publication records, and optional PDF outputs. These commands let you retrieve them from the CLI. All commands on this page are read-only.

Command What it does
ayx one jobs profile <JOB-GROUP-ID> Inspect profile data for an aggregate Job Group
ayx one jobs profile-results <JOB-GROUP-ID> Retrieve profile result details
ayx one jobs pdf-results <JOB-GROUP-ID> Retrieve PDF output for an aggregate Job Group
ayx one jobs publications <JOB-GROUP-ID> List publication records for an aggregate Job Group

All commands accept <JOB-GROUP-ID> as the positional argument and --profile <profile-id>.

Profile data describes the data quality and shape of the job’s outputs — row counts, column types, null rates, and similar statistics.

Terminal window
# Summary profile
ayx one jobs profile <JOB-GROUP-ID>
# Detailed profile results
ayx one jobs profile-results <JOB-GROUP-ID>
# Scoped to a specific Alteryx One profile
ayx one jobs profile <JOB-GROUP-ID> --profile <profile-id>
# Machine-readable
ayx -o json one jobs profile <JOB-GROUP-ID>

profile returns a summary view. profile-results returns a more detailed breakdown. Use profile-results when you need field-level statistics or are building data quality checks.

Some Job Library entries produce PDF outputs when configured to do so.

Terminal window
ayx one jobs pdf-results <JOB-GROUP-ID>
ayx -o json one jobs pdf-results <JOB-GROUP-ID>

The response includes the PDF data or a reference to where it can be retrieved.

Publications are records of when and where job results were pushed to downstream targets.

Terminal window
# All publications for an aggregate job
ayx one jobs publications <JOB-GROUP-ID>
# Scoped to a profile
ayx one jobs publications <JOB-GROUP-ID> --profile <profile-id>
# Machine-readable
ayx -o json one jobs publications <JOB-GROUP-ID>

To publish new results to a target, use ayx one jobs publish — see Jobs.

Check profile results for data quality after every run:

Terminal window
PROFILE=$(ayx -o json one jobs profile-results <JOB-GROUP-ID>)
echo "$PROFILE" | jq '.data.response'

Audit all publication targets for a job:

Terminal window
ayx -o json one jobs publications <JOB-GROUP-ID> \
| jq -r '.data.response[] | [.target, .publishedAt, .status] | @tsv'

List Job Library entries that have produced PDF results:

Terminal window
ayx -o json one jobs list --all \
| jq -r '.data.items[].id' \
| while read -r id; do
COUNT=$(ayx -o json one jobs pdf-results "$id" \
| jq '.data.response | length')
[[ "$COUNT" -gt 0 ]] && echo "$id: $COUNT PDF result(s)"
done