Skip to main content

LearnUpon Data Source

The LearnUpon connector enables you to ingest training and learning data — including users, courses, enrollments, groups, and completion reports — from your LearnUpon portal. Follow the instructions below to create a new data flow that ingests data from a LearnUpon source in Nexla.
learnupon_api.png

LearnUpon

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the LearnUpon connector tile from the list of available connectors. Then, select the credential that will be used to connect to the LearnUpon instance, and click Next; or, create a new LearnUpon credential for use in this flow.

  3. In Nexla, LearnUpon data sources can be created using pre-built endpoint templates, which expedite source setup for common LearnUpon endpoints. Each template is designed specifically for the corresponding LearnUpon endpoint, making data source setup easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    LearnUpon sources can also be configured manually, allowing you to ingest data from LearnUpon endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common LearnUpon endpoints. Each template is designed specifically for the corresponding LearnUpon endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Users

    Retrieve all users registered in your LearnUpon portal, with pagination support, including user profile fields such as name, email, and role.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/users. Response data is extracted from $.users[*]. Results are paginated — use the Page Size parameter to control how many records are returned per page (max 50).
    • Configure the following parameters: Page Size — number of users to return per page (max 50).

    The LearnUpon API paginates results. Nexla handles pagination automatically based on the configured page size. For large portals, use the maximum page size of 50 to minimize the number of API calls per run.

    Get Enrollments

    Retrieve course enrollment records from your LearnUpon portal, with optional filtering by user, course, and enrollment status.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/enrollments. Response data is extracted from $.enrollments[*].
    • Configure the following parameters: User ID — filter enrollments by a specific LearnUpon user ID (optional). Course ID — filter enrollments by a specific course ID (optional). Enrollment Status — filter by status. Options: In Progress, Passed, Failed, Pending. Page Size — number of enrollments per page (max 50).

    Use the Enrollment Status filter to focus on specific completion states. For example, select "Passed" to retrieve only learners who have successfully completed a course, or leave all filters blank to retrieve the full enrollment dataset.

    Get Courses

    Retrieve all courses defined in your LearnUpon portal, including course names, descriptions, and configuration details.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/courses. Response data is extracted from $.courses[*]. Results are paginated.
    • Configure the following parameters: Page Size — number of courses to return per page (max 50).

    This endpoint returns the course catalog for your portal. Use the course IDs from this dataset as input for the Get Enrollments endpoint to correlate enrollment data with specific courses.

    Get Exam Results

    Retrieve exam enrollment results for a specific exam module, including pass/fail status and scores for each learner who attempted the exam.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/exams/{exam_id}/enrollments. Response data is extracted from $.enrollments[*].
    • Configure the following parameters: Exam ID — the numeric ID of the exam module to retrieve results for (required). Page Size — number of exam results per page (max 50).

    The Exam ID is required. You can find the exam module ID from the LearnUpon admin portal or by first running the Get Courses endpoint and identifying the associated exam IDs from the course data.

    Get Exam Question Answers

    Retrieve all learner answers to individual questions for a specific exam, enabling detailed analysis of question-level performance and response patterns.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/exams/{exam_id}/enrollment_questions. Response data is extracted from $.enrollment_questions[*].
    • Configure the following parameters: Exam ID — the numeric ID of the exam to retrieve learner answers for (required). Page Size — number of records per page (max 50).

    This endpoint provides question-level detail, useful for identifying commonly missed questions or analyzing learner knowledge gaps across your training content.

    Get Groups

    Retrieve all learner groups defined in your LearnUpon portal, including group names and configuration settings.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/groups. Response data is extracted from $.groups[*]. Results are paginated.
    • Configure the following parameters: Page Size — number of groups to return per page (max 50).

    Use the group IDs returned by this endpoint as input for the Get Group Memberships endpoint to retrieve user-group assignment data.

    Get Group Memberships

    Retrieve user-group membership records from your LearnUpon portal, with optional filtering by group ID to focus on a specific group.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/group_memberships. Response data is extracted from $.group_memberships[*].
    • Configure the following parameters: Group ID — filter memberships by a specific group ID (optional). Page Size — number of memberships per page (max 50).

    Leave the Group ID blank to retrieve all group memberships across the portal. This endpoint is useful for syncing LearnUpon group assignments with external HR or access management systems.

    Get Learning Paths

    Retrieve all learning paths defined in your LearnUpon portal, including path names and the courses included in each path.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/learning_paths. Response data is extracted from $.learning_paths[*]. Results are paginated.
    • Configure the following parameters: Page Size — number of learning paths to return per page (max 50).

    Use the learning path IDs from this endpoint as input for the Get Learning Path Enrollments endpoint to retrieve user enrollment data for each path.

    Get Learning Path Enrollments

    Retrieve all user enrollments for a specific learning path, including enrollment status and completion data for each learner assigned to the path.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/learning_path_enrollments. Response data is extracted from $.learning_path_enrollments[*].
    • Configure the following parameters: Learning Path ID — filter enrollments by a specific learning path ID (optional). Page Size — number of records per page (max 50).

    Filtering by Learning Path ID is recommended for large portals with many learning paths. Leave it blank to retrieve all learning path enrollment records across the entire portal.

    Get Audit Trails

    Retrieve audit trail events for compliance monitoring, including user actions, login events, and administrative changes, filtered by date range.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/audit_trails. Response data is extracted from $.trails[*].
    • Configure the following parameters: From Date — start date filter for audit trail events (format: YYYY-MM-DD). To Date — end date filter (format: YYYY-MM-DD). Page Size — number of audit records per page (max 50).

    Date filters are strongly recommended for this endpoint to avoid retrieving the full audit history on each run. Use incremental date windows to support ongoing compliance monitoring and audit reporting workflows.

    Get Certifications

    Retrieve all certificates issued to learners in your LearnUpon portal, including certificate details, issue dates, and the associated learner and course.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/certifications. Response data is extracted from $.certifications[*]. Results are paginated.
    • Configure the following parameters: Page Size — number of certifications to return per page (max 50).

    This endpoint is useful for compliance reporting, credentialing systems, and HR integrations that track employee certification status.

    Get Live Learning Events

    Retrieve all live learning (instructor-led training) events and their associated sessions from your LearnUpon portal.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/live_learning_events. Response data is extracted from $.live_learning_events[*]. Results are paginated.
    • Configure the following parameters: Page Size — number of live learning events to return per page (max 50).

    Each live learning event record includes associated session details. Use this endpoint to track ILT attendance, session scheduling, and instructor-led training completion alongside online course data.

    Get Gamification Leaderboard

    Retrieve the gamification leaderboard rankings for your LearnUpon portal, showing learner engagement scores and relative rankings.

    • Issues a GET request to https://{subdomain}.learnupon.com/api/v1/leaderboards. Response data is extracted from $.leaderboards[*]. Results are paginated.
    • Configure the following parameters: Page Size — number of leaderboard entries to return per page (max 50).

    Gamification must be enabled in your LearnUpon portal for this endpoint to return data. This endpoint is useful for learner engagement analytics and incentive program reporting.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

LearnUpon sources can also be configured manually, allowing you to ingest data from LearnUpon endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.

First, select the method that will be used for calls to the LearnUpon API from the Method pulldown menu. The most common methods are:

  • GET: For retrieving data from the API (most LearnUpon data retrieval endpoints use GET)
  • POST: For sending data to the API or triggering actions

API Endpoint URL​

  1. Enter the URL of the LearnUpon API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

    The LearnUpon REST API base URL follows the format https://{subdomain}.learnupon.com/api/v1, where `{subdomain}` is your portal-specific subdomain. Common endpoint paths include:

    • https://{subdomain}.learnupon.com/api/v1/users — retrieve user records
    • https://{subdomain}.learnupon.com/api/v1/enrollments — retrieve enrollment records
    • https://{subdomain}.learnupon.com/api/v1/courses — retrieve course information
    • https://{subdomain}.learnupon.com/api/v1/groups — retrieve group information
    • https://{subdomain}.learnupon.com/api/v1/reports/course_completion — retrieve course completion reports

For a complete list of available LearnUpon API endpoints and their parameters, refer to the official LearnUpon API documentation.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros — all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for LearnUpon reporting endpoints that accept date range parameters, allowing you to incrementally ingest completion or enrollment data across successive data flow runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime — for example, enter (now-7) to indicate the datetime seven time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro — i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu — for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to construct LearnUpon API requests that reference specific user IDs, group IDs, or course IDs from other data sources already available in your Nexla environment.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the LearnUpon API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. LearnUpon API responses typically wrap the primary data collection in a named array within the JSON body.

For example, the /api/v1/users endpoint returns a JSON response where the list of user objects is contained in a users array. By specifying the path to this array, Nexla treats each user object as a separate record.

Path to Data is particularly important for LearnUpon API responses, which commonly use named top-level arrays (e.g., users, enrollments, courses) to wrap the primary data collection.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.users[*] to access the users array, or $.enrollments[*] to access an enrollments array).
    Path to Data Examples for LearnUpon:
    • For the /users endpoint: enter $.users[*]
    • For the /enrollments endpoint: enter $.enrollments[*]
    • For the /courses endpoint: enter $.courses[*]
Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the LearnUpon API endpoint. Suggested data paths generated based on the content and format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. LearnUpon API responses often include pagination metadata (such as total_count or page values) alongside the primary data array. This section allows you to preserve such contextual information.

Metadata paths are particularly useful for preserving pagination state, total record counts, or request timestamps from LearnUpon API responses that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for API versioning or specific content type requirements.

    You do not need to include Authorization headers — Nexla automatically applies the HTTP Basic Authentication credentials configured in your LearnUpon credential. Common headers like Content-Type and Accept are also handled automatically.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched and displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new LearnUpon data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.