Custom Data Ingestion Methods

Clarity offers three methods for ingesting data into Clarity when the source application does not have an API (or the API does not have endpoints corresponding to the data Clarity would like to ingest: Users, Entitlements, etc.).

All methods start with a CSV/report, but each method has a different source for the data normalization process (transform the columns and values to values expected by Clarity).

Not sure where to start?

Contact your Clarity support representative to learn which method is best for you!

Available Methods:

Automated CSV

This option allows you to ship a CSV or report to Clarity, and then Clarity (by way of AWS Lambda) will transform the data provided to convert it to a format that can be processed/imported into Clarity. This Lambda transformation is created and maintained by Clarity.  The options of sending this report to Clarity are as follows:

1. Attach reports using an API POST request

2. Drag and Drop into the Clarity interface

3. More methods coming soon

For this selection, the reports need to be consistent in both the naming of the files and the layout of the unprocessed data, as this information will be built into the AWS Lambda transformation process.  This Lambda transformation will be built, configured, and maintained by Clarity, so if you expect changes to the report or file names, you will need to work with your Clarity Support representative to make updates to this process.

More Information and In-Depth Guide

Check out the following article for a guide on this process:

Auto CSV

API

This method allows you to process the data using the scripting language of your choice, and then send the normalized values to Clarity direct using our API.

Check out our API Docs to learn more

The link below is to our official API documentation following the OpenAPI 3.0 specification

API Documentation

CSV Imports

This method has you manually upload the data to Clarity each time, using drag and drop. Clarity then reads the CSV, and provides a section of the report so you can see examples of the data you just uploaded.  Next, you explicitly tell Clarity what data is stored in each column for the data you uploaded, then Clarity will ingest the report using the values specified.  This column selection process must be completed each time you upload the report.

More Info and In-Depth Guide

Check out the following article for a guide on this process:

CSV Imports

Need help?