CSV Upload
Learn how to upload new or update existing user profiles on the CleverTap dashboard using CSV Upload feature.
Overview
With the Profile Uploads feature, you can do the following:
- Upload new user profiles on the CleverTap dashboard in bulk by uploading a CSV file with a list of user profiles.
- Add or update information for existing user profiles.
Private Beta Release
This feature is currently released in private Beta.
Upload Profiles
To upload profiles to the CleverTap dashboard:
- Log in to your CleverTap account and navigate to Settings > CSV Uploads.
- Click + Upload.
- Drag and drop the .csv file or click Browse to upload the required file.
- Enter the upload Name and click Save & Upload to upload the file. We recommend keeping the upload Name unique, as it will help you identify your upload easily.
The file upload Status changes to Start Mapping at this point.
- Click Map. You have the following two options to map your uploaded user profiles to data types and user properties:
- Manually map file: Select this option to manually define the Data Type and User Property for all the columns in your uploaded CSV file.
Missing User Property
If you cannot find the User Property for a particular column of your file, you can leave it undefined. CleverTap creates that user property on your dashboard at the time of file processing.
- Upload manifest file: Select this option if you have a manifest file that maps your user profiles to data types and user profiles on the CleverTap dashboard. You can drag and drop the file directly or browse the file location on your local system.
- Click Process File. You are navigated back to the Profile Upload page, and the status of the file upload changes to Processing. It may take up to five minutes for the file to upload.
Field | Description |
---|---|
Name | Displays the upload name entered at the time of uploading the file. We recommend keeping this name unique, as it helps you identify your upload quickly. |
Uploaded on | Displays the date on which the file is uploaded. |
Uploaded by | Displays the email ID of the person uploading the file. |
Status |
|
Errors | Displays the number of records in error and not uploaded to the CleverTap dashboard. |
Processed | Displays the number of records that are uploaded to the CleverTap dashboard successfully. |
File Format
This section provides information about the sample .csv and manifest file formats.
CSV File Format
This file contains all the user profiles you may want to add or update on the CleverTap dashboard. You can only upload a CSV file with a size of up to 1 GB. Download the sample CSV file. The following is the sample CSV file:
identity
[identity](doc:concepts-user-profiles)
is a mandatory field. However, if you want to make profile updates using the CleverTap ID, you can use the objectId
in place of identity. The following is the sample format for the CSV file using objectId
:
Manifest File Format
This file maps the details of your user profiles to CleverTap profiles. The file name format for the manifest file is anyfilename.manifest
. Every manifest file must have a unique name. The following keys are mandatory in a manifest file:
Expected Key | Description |
---|---|
columns |
|
The following is a sample manifest file for profiles:
{
"columns": {
"identity": {
"ctName": "identity",
"dataType": "STRING"
},
"id_name": {
"ctName": "Name",
"dataType": "STRING"
},
"id_email": {
"ctName": "Email",
"dataType": "STRING"
},
"id_phone": {
"ctName": "Phone",
"dataType": "STRING"
},
"id_gender": {
"ctName": "Gender",
"dataType": "STRING"
},
"Employment Status": {
"ctName": "empStatus",
"dataType": "STRING"
},
"Education status": {
"ctName": "education_status",
"dataType": "STRING"
},
"Wallet Balance": {
"ctName": "Wallet bBalance",
"dataType": "INTEGER"
},
"DOB": {
"ctName": "DOB",
"dataType": "STRING"
},
"MSG-SMS": {
"ctName": "MSG-sms",
"dataType": "BOOLEAN"
}
}
}
Field Mapping in Manifest File
If a column is not mapped to a CleverTap property name, the data is processed with the column name as the property name.
FAQs
Q. What is the maximum file size for upload?
A. You can upload a maximum of 1 GB for each data file.
Q. What are the mandatory columns in the Profile Files?
A. identity
or Object ID
is the mandatory field for adding or updating any user profile on the CleverTap dashboard.
Q. Can multiple CSV files be uploaded simultaneously?
A. You can upload multiple CSV files simultaneously, even when existing files are currently processing.
Q. Does CleverTap support uploading data with columns of data type Date?
A. Columns of data type Date are uploaded to CleverTap as String. CleverTap is working on this enhancement and will soon make it available.
Why is there a mismatch in the number of records included in the file and uploaded to CleverTap?
A. This mismatch occurs when a few rows may not have been processed due to some error. In such cases, the total number of rows in a file = Number of rows in Error + Number of rows Processed.
What if the user skips the mapping step at the time of file upload?
A. The user can skip mapping the columns at the time of file upload. They can go back to the Profile Upload page and map the columns later.
What are the different file upload statuses?
A. The following are different file upload statuses:
Status | Description |
---|---|
Start Mapping | This indicates that the user can now map the uploaded user profiles to data types and the corresponding user properties on the CleverTap dashboard. |
Processing | This indicates the file is now being processed and uploaded. |
Completed | This indicates one of the following:
|
Rejected | This indicates the file was not at all uploaded due to one of the following reasons:
|
Updated 5 months ago