Intro
Cordial lets you activate real-time data and deliver tailored messages that adapt to changing customer signals. To learn more about the Cordial API, visit their page (https://api.cordial.io/docs/v1/).
You connect to your Cordial account in the Data Center. This topic discusses the fields and menus that are specific to the Cordial connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.
Prerequisites
To connect to your Cordial account and create a DataSet, you must have the following:
-
An encoded Cordial API key
-
The password for your Cordial account
For information about generating a Cordial API key, see https://support.cordial.com/hc/en-us/articles/115005365087-API-Keys.
Connecting to Your Cordial Account
This section enumerates the options in the Credentials and Details panes in the Cordial Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.
Credentials Pane
This pane contains fields for entering credentials to connect to your Cordial account. The following table describes what is needed for each field:
|
Field |
Description |
|---|---|
| API Key | Enter your encoded Cordial API key. For information about generating an API key, see "Prerequisites," above. |
| Password | Enter the password for your Cordial account. |
Once you have entered valid Cordial credentials, you can use the same account any time you go to create a new Cordial DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.
Details Pane
This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.
|
Menu |
Description |
||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Report |
Select the Cordial report you want to run. The following reports are available:
|
||||||||||||||||||||||||||||||||
|
Select the Type |
Select the type of account contact attributes you want to pull into Domo. |
||||||||||||||||||||||||||||||||
|
Select the Index |
Select an index value of 0 or 1 for your "Account Contact Attributes" report. |
||||||||||||||||||||||||||||||||
|
Active Status |
Select the desired job status for jobs listed in your "Jobs" report. |
||||||||||||||||||||||||||||||||
|
Interest Name (Optional) |
Enter the interest name you want to filter your report by. |
||||||||||||||||||||||||||||||||
|
List Name (Optional) |
Enter the list name you want to filter your report by. |
||||||||||||||||||||||||||||||||
|
Time (Optional) |
Enter the time you want to filter your report by. You can include modifiers such as lt, gt, lte, gte, between, start, and between.end. |
||||||||||||||||||||||||||||||||
|
Action (Optional) |
Enter an action to filter your report by. This can include click, open, send, or any user-defined actions. |
||||||||||||||||||||||||||||||||
|
Email (Optional) |
Enter the email address (search contact primary key) you want to filter your report by. |
||||||||||||||||||||||||||||||||
|
Attribute Key (Optional) |
Enter the attribute key you want to filter your report by. This can be the key of any custom attribute set up in your system. |
||||||||||||||||||||||||||||||||
|
Include Key (Optional) |
Enter the include key you want to filter your report by. |
||||||||||||||||||||||||||||||||
|
Job Name (Optional) |
Enter the job name you want to filter your report by. |
||||||||||||||||||||||||||||||||
|
Contact ID |
Select the contact ID you want to filter your report by. |
||||||||||||||||||||||||||||||||
|
Purchase Date (Optional) |
Enter the purchase date in conjunction with eq, lt, gt (YYYY-MM-DD HH:ii:ss). For more information, reach out to your Cordial support representative. |
||||||||||||||||||||||||||||||||
|
Schedule ID |
Select the schedule you want to filter your report by. |
||||||||||||||||||||||||||||||||
|
Supplement Key |
Select the supplement key you want to filter your report by. |
||||||||||||||||||||||||||||||||
|
Fields (Optional) |
Enter the names of the fields (columns) you want to appear in your report. You can separate multiple fields using a comma. |
Other Panes
For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.
FAQs
What version of the Coridal API does this connector use?
This connector uses version 1 of the Cordial API (https://api.cordial.io/v1/).
How often can the data be updated?
As often as needed.
Are there any API limits I should be aware of?
No.
Comments
0 comments
Please sign in to leave a comment.