Data Templates
In addition to the online dashboards, clients can also retrieve raw data, enabling you to analyze and apply your own insights in your environment and keep the history in your data lakes.
Weekly data retrieval and a 1-month data retention period are included for all Clickatell clients. More frequent data synchronization and an extended retention period are available as an upgrade.
| STANDARD | UPGRADE | |
|---|---|---|
Delivery frequency | Weekly | Daily |
Data retention period | 1 Month | 3 Months |
Data is delivered in the form of data templates. Data Templates are generic datasets created for each application and normalized for clients' easy consumption. You can download these sets of raw data (CSV files) from a Clickatell-hosted cloud SFTP server. You have access to all templates associated with your subscription package, e.g., if you subscribed to the Transact package, you can access the data templates associated with Transact applications as well as all the templates associated with the Interact and Connect applications.
Templates per package
CONNECT
| Data Template Name | Template Definition |
|---|---|
Advanced SMS Inbound Detail Template | Contains data elements with details about inbound/mobile-originating (MO) messages. An inbound message is a message sent from a customer handset to Clickatell clients. CMX is the legacy platform (with built-in SMS Adapter/Engine). |
Advanced SMS Outbound Detail Template | Contains data elements with details about the outbound/mobile-terminating (MT) messages. An outbound message is a message sent by a Clickatell customer to their customers’ mobile handsets. CMX is the legacy platform (with built-in SMS Adapter/Engine). |
SMS Detail – Inbound/ Outbound Template | Contains data elements with details about SMS messages in both directions (Inbound and Outbound messages).* Only applicable to MC2 SMS customers |
WA - Inbound/ Outbound Template | Contains data elements with details about inbound and outbound WhatsApp messages, including WhatsApp message templates. |
INTERACT
| Data Template Name | Template Definition |
|---|---|
Chat Flow Template | Contains data elements with details about interactions between customers and the chatbot. |
Chat Desk Template | Contains data elements with details about interactions between customers and agents via the Chat Desk application. |
TRANSACT
| Data Template Name | Template Definition |
|---|---|
Chat 2 Pay Template | Contains data elements related to details captured through the Transact layer. |
Delivery Conditions
A detailed Data Sharing Agreement between Clickatell and you, the client, outlines the terms and conditions for data sharing. This is to establish clear guidelines ensuring the responsible and ethical use of the shared data, protecting the interests of all parties involved.
The high-level conditions for data sharing are:
Data Templates will be available to clients two weeks after the commercial details have been finalized and signed.
Each customer will receive one file per template per day based on their Delivery Frequency and the purchased package.
For weekly deliveries, seven files per associated template will be delivered once a week.
A week is considered Monday to Sunday. Data will be delivered on the following Monday.
For daily data delivery, one file per associated template will be delivered every 24hrs (Day -1).
Delivery of historical data is not included.
Last updated
