Coassemble Data Source

The Coassemble connector enables you to ingest courses, learner tracking records, and client/user identity data from your Coassemble workspace into Nexla. This connector is particularly useful for applications that need to consolidate training and learning analytics, report on learner progress and completions, or sync identity and course metadata into a data warehouse or downstream system.

Coassemble is a headless learning management platform that exposes courses, learner tracking, and identity data through its headless API. Follow the instructions below to create a new data flow that ingests data from a Coassemble source in Nexla.

Coassemble

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 Coassemble connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Coassemble instance, and click Next; or, create a new Coassemble credential for use in this flow.

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

   Coassemble sources can also be configured manually, allowing you to ingest data from Coassemble 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 Coassemble endpoints. Each template is designed specifically for the corresponding Coassemble 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.

  List Courses

  This endpoint returns a paginated list of all courses in your Coassemble account. Use it to ingest your full course catalog, including course metadata, for reporting or to drive downstream flows that reference course IDs.

  • This endpoint requires no additional configuration. Select the template, and Nexla automatically retrieves all courses accessible to your workspace.
  • The endpoint is paginated and steps through pages automatically, fetching additional pages of results until all courses have been ingested.

  The response is a JSON array of course objects. Each element is treated as an individual record. Course IDs returned here can be used as input for the Get Course By ID, Export Course As SCORM, and List Course Translations endpoints.

  Get Course By ID

  This endpoint fetches a single course by its numeric ID, returning the full course detail. Use it when you need the complete structure and metadata for one specific course rather than the summary list.

  • Enter the numeric ID of the course to retrieve in the Course ID field. You can obtain course IDs by first running the List Courses endpoint.
  • The endpoint returns a single course object, which is treated as one record.

  This endpoint is not paginated because it returns a single course. Ensure the Course ID corresponds to a course in your workspace.

  List Screen Types

  This endpoint is a reference-data lookup that returns the list of available screen component types used when building courses. It is not a live learner-data endpoint, but is useful for understanding or validating the screen types supported when authoring courses programmatically.

  • This endpoint requires no additional configuration. Select the template, and Nexla retrieves the full list of available screen types.
  • The response is a JSON array, with each screen type treated as an individual record.

  Screen types are static reference data and change infrequently. This endpoint is most useful as a one-time or low-frequency ingestion.

  List Trackings

  This endpoint returns a paginated list of tracking objects, which store learner progress and completion records. Use it to ingest learning analytics for reporting on course engagement and completions across your learners.

  • This endpoint requires no additional configuration. Select the template, and Nexla automatically retrieves all tracking objects accessible to your workspace.
  • The endpoint is paginated and steps through pages automatically until all tracking records have been ingested.

  Tracking objects link learners and courses with progress and completion data. For details on the structure of tracking records, refer to the Coassemble Tracking API documentation.

  Get Tracking By ID

  This endpoint fetches a single tracking object by its ID, returning the full progress and completion detail for that record. Use it when you need detailed tracking data for one specific learner-course record.

  • Enter the unique identifier of the tracking object to retrieve in the Tracking ID field. Tracking IDs can be obtained by first running the List Trackings endpoint.
  • The endpoint returns a single tracking object, which is treated as one record.

  This endpoint requires headless authoring access. Ensure your workspace has the appropriate access level enabled for the headless API.

  List Clients

  This endpoint returns a paginated list of client identifiers, which represent tenant or organization-level learner groups in Coassemble. Use it to ingest your client identity directory for multi-tenant reporting or identity synchronization.

  • This endpoint requires no additional configuration. Select the template, and Nexla automatically retrieves all client identifiers accessible to your workspace.
  • The endpoint is paginated and steps through pages automatically until all clients have been ingested.

  Clients support arbitrary metadata key-value pairs. For details on the identities model, refer to the Coassemble Identities API documentation.

  List Users

  This endpoint returns a paginated list of learner user identifiers, optionally filtered by client identifier. Use it to ingest your learner directory for reporting or to keep learner identities in sync with downstream systems.

  • This endpoint requires no additional configuration to return all users. To filter users by a specific client, the response can be narrowed using the clientIdentifier query parameter via manual configuration.
  • The endpoint is paginated and steps through pages automatically until all users have been ingested.

  Users support arbitrary metadata and can be associated with a client identifier. For details, refer to the Coassemble Identities API documentation.

  Export Course As SCORM

  This endpoint exports a course as a SCORM package for use in external learning management systems. Use it when you need to deliver a Coassemble course through a third-party LMS that supports SCORM.

  • Enter the unique identifier of the course to export in the Course ID field. Course IDs can be obtained by first running the List Courses endpoint.
  • The endpoint returns the SCORM export detail for the specified course as a single record.

  SCORM is a widely supported standard for packaging e-learning content so it can be imported into external LMS platforms. Verify that your target LMS supports the SCORM version produced by Coassemble.

  List Course Translations

  This endpoint lists all translations for a parent course. Use it to ingest the set of available language versions for a course, for example to report on localization coverage.

  • Enter the numeric ID of the parent course whose translations should be listed in the Course ID field. Course IDs can be obtained by first running the List Courses endpoint.
  • The response is a JSON array of translation objects, with each translation treated as an individual record.

  For details on the translation model and supported language codes, refer to the Coassemble Translations API documentation.

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

Coassemble data sources can be manually configured to ingest data from any valid Coassemble API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations, such as filtering the user list by a specific client identifier.

With manual configuration, you can also create more complex Coassemble sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the Coassemble API from the Method pulldown menu. The Coassemble headless read endpoints use:

   • GET: For retrieving courses, tracking records, identities, screen types, and translations

API Endpoint URL

3. Enter the URL of the Coassemble 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. Coassemble headless endpoints share the base URL https://api.coassemble.com/api/v1/headless/—for example, https://api.coassemble.com/api/v1/headless/courses retrieves all courses.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Path to Data

Optional

If only a subset of the data returned by an 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. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, the Coassemble list endpoints (such as courses, trackings, clients, and users) return a JSON array of records at the top level of the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

• 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., $.data.items[*] to access an array of items within a data object).
  Path to Data Example:

  Coassemble list endpoints return a top-level JSON array of records. To treat each element of this array as a record, enter the path as $[*].

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 API endpoint. Suggested data paths generated based on the content & 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.

  

Request Headers

Optional

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

  You do not need to include any headers already present in the credentials. The COASSEMBLE-V1-SHA256 Authorization header is constructed automatically by Nexla based on your credential configuration.

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 & 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 Coassemble 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.