get_learner_progress
Read-onlyIdempotent
Retrieve a learner's progress in a published course using user ID and published course ID. Returns completion counts for that exact publication, preventing cross-domain mismatches.
Instructions
How far one learner has got in one course on one domain.
`user_id` is the learner's Skilljar id, the same value v2's `list_students`
returns. `published_course_id` identifies the course ON A PARTICULAR DOMAIN. A course
published to two domains has two of them, with separate progress, and this
returns the one asked for.
That distinction is load-bearing. Skilljar's own by-id endpoint
resolves by the underlying course, not the publication, and returns a DIFFERENT
domain's record with a 200 when a course is published more than once. This tool selects
from the learner's full list instead, so the answer always matches the id given.
COUNTS ONLY, NOT WHICH LESSONS - the per-lesson endpoint returns 404 upstream.
A learner not enrolled in that published course is a not-found error, and the
message says how many enrolments they do have.
Requires `CSA_SKILLJAR_V1_API_KEY`, a separate credential from the v2 client.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | ||
| published_course_id | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| score | No | ||
| course_id | No | ||
| max_score | No | ||
| domain_name | No | ||
| enrolled_at | No | ||
| completed_at | No | ||
| course_title | No | ||
| lesson_count | No | ||
| enrollment_id | No | ||
| credits_earned | No | ||
| success_status | No | ||
| has_certificate | No | ||
| latest_activity | No | ||
| enrollment_count | No | ||
| credit_unit_plural | No | ||
| published_course_id | Yes | ||
| required_lesson_count | No | ||
| completed_lesson_count | No | ||
| completed_required_lesson_count | No |