Getting started

Procuring API access

The Data Extraction (DEx) API is premium Kallidus functionality. To get started, reach out to your Customer Experience Manager (CEM) to learn about pricing and contractual details.

Once paperwork has been signed, your CEM will work with Kallidus Support to provision your OAuth credentials. As part of this process, you'll also be provided with an OAuth scope specific to the DEx API.

With your OAuth credentials and scope in hand, you're ready to start extracting data.

Data extraction workflow

As a general guideline, here's what a typical customer data extraction workflow looks like:

1. Pull reporting data from Kallidus once daily
   1. Download the Postman collection under helpful links to start exploring the DEx API
2. Store the reporting data in your internal data lake, warehouse, or BI tool
3. Reassemble the reporting data to match Kallidus datasets
   1. Review the resources under helpful links to understand dataset construction
4. Transform the reporting data to fit your internal use cases
5. Build and share internal reports

ℹ️

The DEx API is currently in beta release