The CXI Public API enhances audience upload management in the CXI platform, offering benefits such as full CSV audience control, audience list management without platform login, improved HRIS automation, and secure token authentication.
Key features include Audience Import Management for creating, viewing, updating, and deleting lists, and an Audience Import Async Job for processing CSV data.
The API aims to provide greater flexibility and automation in managing audience data, with plans for future improvements in data management and analytical data export capabilities.
Information
Introduction
The API joins the two currently available CXI audience upload management functions, CSV upload, and HRIS integration. The CXI API not only provides the same level of security of encrypted data in transit as the current capability but also provides the following benefits:
- Full CSV audience control
- Audience list management (create, update, delete) without logging into the platform
- Greater HRIS automation management*
- Unique token authentication between your organization and CXI
The API will continue to be improved with additional capabilities. Future additions include but are not limited to improved data management and analytical data export for in-depth analysis.
Key aspects of the current API are audience import and audience import asynchronous job status. Properly implementing these key aspects is a critical step in getting value from the API and CXI platform. Below is the high-level description of each aspect – Audience Import Management and Audience Import Async Job.
Audience Import Management
Audience Import Management is a key aspect of the API. As a user, viewing, creating, updating, and deleting lists are all within your control.
- Audience Import view – The returned list will not only provide the list name, but also basic information such as the column headers and created and last modified date.
- Audience Import creation – The creation capability allows the upload of a CSV and the creation of multiple audiences based on that CSV in the Audience Creation section of the Settings section. (CSV file MUST only contain active employees.)
- Audience Import update – As a user, you can either re-upload the entire list and overwrite the current CSV in the system, or use the update capability to make changes to specific records.
- Audience Import Deletion – Deletion is only available if the uploaded list has not been used.
Audience Import Async Job
The Async Job is an important resource of the API. This process is the workhorse that imports each row of your CSV into the CXI platform. This process also provides real-time status and error information in the event of a failure.
Please note, depending on the number of records, this process will take time.
*Audience Import Automation
The Public API allows this capability of scheduled connection to the CXI platform. The automation setup will be dependant on your IT team’s API connection protocols and development.
The API Reference outlines the API information your IT team will need to set up your connection to the CXI. Once the connection is in place, you will be able to take advantage of the current and future capabilities of the API.
GO TO: CXI PUBLIC API: Audience Import Documentation
FAQ
What are the main benefits of using the CXI Public API?
The main benefits include full CSV audience control, ability to manage audience lists without logging into the platform, greater HRIS automation management, and unique token authentication between your organization and CXI. It also provides the same level of security for encrypted data in transit as existing capabilities.
What functions are available in the Audience Import Management feature?
Audience Import Management allows users to view, create, update, and delete audience lists. Users can upload CSVs to create multiple audiences, make changes to specific records, and delete unused lists. It also provides basic information such as column headers and modification dates for each list.
What is the purpose of the Audience Import Async Job?
The Audience Import Async Job is responsible for importing each row of your CSV into the CXI platform. It provides real-time status updates and error information in case of failures. The process duration depends on the number of records being imported.