API Category: Data Management
Cheetah Digital allows you to load data into your database by means of API calls. The platform provides several different endpoints, with different features designed to meet your specific requirements.
The Data Management endpoints are as follows:
|
Endpoint |
Description |
|
|
|
This feature is used to submit data collected from your consumers via a Web Form, or from another system via an API Post. |
|
|
|
This endpoint provides the same functionality as the HTTP POST endpoint, except that it requires authentication using OAuth 2.0, and supports JSON and XML messages. |
|
|
|
Through this endpoint, you can send a Base64-encoded file (in either text, comma-separated values, or Microsoft Excel format) along with the API request. |
|
|
|
This endpoint allows you to send a single API request containing multiple records to be loaded into multiple tables. All records are inserted into these tables sequentially. |
|
|
|
A single API request sent to this endpoint can be used to load data into multiple joined tables. All records are inserted into these tables simultaneously, rather than sequentially, which greatly improves performance. |
The following charts depicts the differences between the various Data Management endpoints.
|
HTTP POST |
Standard Data Load |
Batch Import |
Sequential Data Load |
Advanced Data Load |
|
|
XML Support |
|
|
|
|
|
|
JSON Support |
|
|
|
|
|
|
OAuth 2.0 authentication |
|
|
|
|
|
|
Load data to joined tables |
|
|
|
|
|
|
Load multiple records to the root table in the same request |
|
|
|
|
|
|
Requires an API Post * |
|
|
|
|
|
|
Endpoint can be used to trigger a Campaign |
|
|
|
|
|
* Some of the endpoints in this category require you to set up an API Post. The API Post includes a Data Map, which provides data handling instructions, such as where to store the inbound data contained within the API request, and whether this data should be used to update existing records and / or create new records.
Troubleshooting
|
|
Troubleshooting a Data Management APIDatabase Management Utilities
In addition to the endpoints listed above that are used to load data, the Data Management category also includes a set of endpoints that provide database management functions.
The Database Management Utility endpoints are listed below.
|
Endpoint |
Description |
|
|
|
* This endpoint has been temporarily deactivated. |
This endpoint allows you to retrieve activity details (such as "bounces," "clicks," opt outs," etc." for a specific recipient. This endpoint provides several different search options for finding the desired recipient. |
|
|
This endpoint allows you to retrieve a list of all the custom stored procedures defined in your account. |
|
|
|
This endpoint allows you to manage your Data Maps, by defining new ones, or by updating or deleting existingones. |
|
|
|
This endpoint allows you to create a Folder. |
|
|
|
This endpoint allows you to manage your FTP Profiles, by defining new ones, or updating or deleting existing ones. |
|
|
|
This endpoint allows you to manage your FTP Import Templates, by defining new ones, or updating or deleting existing ones. |
|
|
|
This endpoint is used to request a list of Hosted Item folder and sub-folders. This endpoint can also be used to request a list of the contents of a specified folder or sub-folder. |
|
|
|
This endpoint allows you to manage your Hosted Items (such as image files or HTML files, for example), by uploading new ones, or replacing existing ones. |
|
|
|
This endpoint is used request information about the Merge Symbols used in your Campaigns. |
|
|
|
This endpoint allows you to request information for a specified record within a table, and indicate what fields you want returned in the response. You can also use this endpoint to bring back a set of records that match a set of search criteria. |
|
|
|
This endpoint allows you to request information about the tables in your database. |
