Introduction

General overview

The Data Extraction (DEx) API enables customers to retrieve data from the Kallidus Reporting database for use with their internal data lakes, warehouses, and BI tools.

The DEx API does not expose real-time (live) data. Instead, it exposes the latest data available within Kallidus Reporting, which is refreshed multiple times throughout the day. Kallidus Reporting is powered by 15 datasets in total, all of which will eventually be available via the DEx API .

Reporting datasets for Learn currently/soon-to-be available via the DEx API:

• Learning Progress - for reporting on course- and lesson-level compliance
• Accreditations - coming soon
• Events - coming soon

Reporting datasets for Perform currently/soon-to-be available via the DEx API:

• Reviews - coming soon

Technical overview

The DEx API is a read-only, REST-based API built on the OData v4 protocol. It uses standard HTTP GET requests and returns JSON-formatted responses.

For large responses, the API uses server-driven pagination (5000 records/page) and supports the standard OData $skip query parameter. When pagination occurs, an odata.nextLink property is returned in the response to retrieve the next page of results.

ℹ️

The DEx API is currently in beta release