Raw Data Access
Last updated
Last updated
© Copyright 2024 Clickatell. All rights reserved.
In addition to the online dashboards, clients can also retrieve raw data from a secure server, enabling you to analyze and apply your own insights in your environment and keep the history in your data lakes.
The raw data is supplied as standardized, templated sets of data elements referred to as "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.
The weekly Data Sharing service is included as standard in all packages. You can upgrade to a higher frequency delivery at an additional cost. The table below describes the options available.
The Data Sharing service includes:
A set of standard data templates based on the package purchased. Each template includes a standard set of data elements. Data can be downloaded on a fixed schedule based on the selected delivery frequency.
The associated manifest file containing a summary view of the data in each template (if downloads occur daily or more frequently – see below).
A data dictionary with detailed definitions of each data element and possible values.
One setup per account – setup includes automatic mapping of datasets and pipeline augmentation based on package selection.
The Data Templates included in the offering are based on the package a client has purchased. For example, the Interact package includes all Interact templates plus the Connect templates. Similarly, the Transact package includes all Transact templates plus the Interact and Connect templates.
| 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. |
| 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. |
| Data Template Name | Template Definition |
|---|---|
Chat 2 Pay Template | Contains data elements related to details captured through the Transact layer. |
A detailed Data Sharing Agreement between Clickatell and you, the client, outlines the terms and conditions for data sharing. This establishes clear guidelines to ensure the responsible and ethical use of the shared data and to protect the interests of all parties involved.
