get_course_progress {skilljaR}

Get Course Progress for a List of Users

Description

Returns a data.frame with all course progress details for a list of user id's.

Usage

get_course_progress(user_ids, api_token)

Arguments

user_ids

Vector of user id's for which you want course progress data

api_token

Your personalized token provided by 'Skilljar'

Details

The API call only returns one user at a time. If you have many users then it may take a long time for the function to return. You may also exceed the 'Skilljar' API rate limit.

Utilizing the API requires a token. This must be obtained by logging in at dashboard.skilljar.com and going to Organization -> API Credentials. There are different strategies for storing api tokens securely. It is an unnecessary risk to store the token in the script!

Value

A data frame with users and user data

See Also

See https://api.skilljar.com/docs/ for documentation on the 'Skilljar' API.

Examples

## Not run: 
# Get some user id's
users <- get_users(domain = "training.mycompany.com",
users_desired = 10,
api_token = "my-token")

# Get course progress data
progress <- get_course_progress(user_ids = unique(users$user.id),
api_token = "my-token")

## End(Not run)