Ternair biedt een bibliotheek van datamarts. Deze syteem datamarts worden door Ternair aan jullie beschikbaar gesteld en kunnen met een API worden ontsloten voor bijvoorbeeld reporting.
In de algemene instellingen kun je de systeem datamarts vinden.
Je kunt systeem datamarts ontsluiten door op het tandwielicoon te klikken.
API’s
Voor elke systeem datamart heb je de beschikking tot 2 API’s:
- Sleutel API
Deze API retourneert data op basis van een sleutel als input parameter
- Dataset API
Deze API retourneert de complete onderliggende datastore (met behulp van paginering)
API sleutel(s)
Om deze API te gebruiken is authenticatie nodig via een Authorisation header met een Bearer token. Deze moet worden toegevoegd in het HTTP-verzoek.
Bijvoorbeeld:
Authorization: Bearer b383ebef-3456-491c-ae14-9a6ec91e9d2c
Als alternatief kan er gebruik gemaakt worden van deze token in de cURL indien een connectie met een Authorisation header niet mogelijk gemaakt kan worden hiervoor moet &apikey=[actualSecurityKey] toegevoegd worden aan de cURL
De paginagrootte kan worden aangegeven, iedere waarde van 20 tot 100000 (100k) wordt geaccepteerd. Standaard geeft een pagina 10.000 rijen terug.
Het dataformat en de paging moeten worden opgegeven in de cURL.
Voorbeeld cURL:
https://campaign5-datamart-api.ternairsoftware.com/c01efd2d-c7e1-4d12-8cdd-c87b9e56ea00/data?page=1&resultformat=json
Systeem datamarts
Ternair stelt de onderstaande datamarts beschikbaar.
Ternair Clicks
| Columnname | Description | Remarks | Key |
|---|---|---|---|
| Click Id | Unique ID | Big Integer | Primary key |
| Application Name | Website name | ||
| Create Date | Click date | format “YYYY-MM-DD” | |
| Emailaddress | optional, maybe retrieved from External Reference, TID or Fingerprint – Foreign key | Foreign key | |
| External Reference | External value / ID | ||
| Fingerprint | Browser Fingerprint | Generated by Ternair | Foreign key |
| TID | Ternair ID | Unique contact ID, generated by Ternair | Foreign key |
| Time on page (seconds) | Time on page in seconds | Calculated by Ternair | |
| URL | URL which generated click | ||
| Webpush endpoint | Webpush identification | optional, if available | Foreign key |
Ternair Clicks Parameters
This datamart contains all url-parameters that belong to a specific click
| Columnname | Description | Remarks | Key |
|---|---|---|---|
| Parameter id | Unique ID | Big Integer | Primary key |
| Click id | Reference to Click datamart | Foreign key | |
| Name | Parameter Name | ||
| Value | Parameter Value |
Ternair Clicks Tags
This datamart contains all tags that belong to a specific click
| Columnname | Description | Remarks | Key |
|---|---|---|---|
| Tag id | Unique ID | Big Integer | Primary key |
| Click id | Reference to Click datamart | Foreign key | |
| Name | Tag Name | ||
| Value | Tag Value |
Ternair Email Statistics
| Datavoorbeeld:
{ “Denied (feedbackloop)”: 0, } |
Voor deze statistieken volgen het SAME standaard: https://www.emailstats.nl/definities-same-email-marketing-statistieken-standaard/
| Columnname | Description | Remarks | Key |
|---|---|---|---|
| Run id | Unique ID | Big Integer | Primary key |
| Test run | Boolean / true or false | ||
| Block id | Internal number email block | Foreign key | |
| Block description | Description of email block | ||
| Run date | Execution data / time of this run | format “yyyy-mm-dd hh:mm:ss“ | |
| Subject | The email-subjectline | ||
| Sents | Total number of records | ||
| Audience | Total number of records | ||
| Sender | Description of sender | ||
| Sender email | Email address of sender | ||
| Selection id | Unique Id of selection to which this run belongs | Foreign key | |
| Selection | Name of the selection to which this run belongs | ||
| External reference (selection) | External reference of the selection to which this run belongs | ||
| External reference (campaign) | External reference of the campaign to which this selection belongs | ||
| Campaign id | Unique Id of campaign to which this selection belongs | Foreign key | |
| Campaign | Name of the campaign to which this selection belongs | ||
| CTO | Click to Open ratio | ||
| CTR | Click through rate | ||
| Segment code | |||
| Offer code | |||
| Errors | Number of records not sent due to an error | ||
| Denied (suppression) | Number of records denied (suppressed / filtered from sent / audience) | ||
| Denied (feedbackloop) | Number of records denied of type Feedbackloop | ||
| Denied (empty) | Number of records denied of type Empty | ||
| Denied (blacklist) | Number of records denied of type Blacklist | ||
| Denied (invalid) | Number of records denied of type Invalid | ||
| Denied | Total number of denied records | ||
| Bouncers (rejected) | Number of bouncers of type Rejected | ||
| Bouncers (hard) | Number of bouncers of type Hard | ||
| Bouncers (soft) | Number of bouncers of type Soft | ||
| Bouncers (feedbackloop) | Number of bouncers of type Feedbackloop | ||
| bouncers (suppression) | Number of bouncers of type Suppression | ||
| Bouncers (unknown) | Number of bouncers of type Unknown | ||
| Bouncers | Total number of bounced records | ||
| Bounce rate | Ratio of bounce / sent | ||
| Total openers | Number of opened mail | ||
| Distinct openers | Unique number of opened mail | ||
| Open rate | Ratio of Total openers / sent | ||
| Accepted | Number of mails delivered | ||
| Total clicks | Total number of clicks | ||
| Distinct clicks | Unique number of clicks |
Ternair Email Statistics Clients
Voorbeeld cURL:
https://campaign5-datamart-api.ternairsoftware.com/74557897-3f18-4571-9c73-4088c3b3506e/data?page=1&resultformat=json
| Datavoorbeeld:
{ |
| Veld | Omschrijving |
| Occurences | Aantal geopende mails voor client |
| E-mail client | ID E-mailclient geopende mail |
| Run id | ID van verzending |
| Columnname | Description | Remarks | Key |
|---|---|---|---|
| Email client | Name of emailclient | ||
| Number of email clients | Number of this client in this run | ||
| Run id | Reference to run where this number of clients belong to | Primary key |
Ternair Email Statistics Devices
Voorbeeld cURL:
https://campaign5-datamart-api.ternairsoftware.com/34d82f00-030f-4368-a865-6ee459e995c3/data?page=1&resultformat=json
| Datavoorbeeld:
{ |
| Veld | Omschrijving |
| Devices | Aantal geopende mails voor device |
| Device id | ID device geopende mail |
| Run id | ID van verzending |
| Columnname | Description | Remarks | Key |
|---|---|---|---|
| Device | Device name | ||
| Number of devices | Number of this devices in this run | ||
| Run id | Reference to run where this number of devices belongs to | Primary key |
Ternair Ezines
| Columnname | Description | Remarks | Key |
|---|---|---|---|
| Ezine id | Unique ID subscription | Primary key | |
| Ezine code | code of ezine (short name) | ||
| Ezine description | description of ezine | ||
| Thumb url | URL to thumb of ezine | ||
| BusinessUnit code | code of business unit ezine belongs to | ||
| BusinessUnit description | description of business unit ezine belongs to | ||
| Start date | Startdate of subscription | ||
| End date | Enddate of subscription | blank if subscription is active | |
| emailaddress | |||
| Initials | |||
| First name | |||
| Middle name | |||
| Last name | |||
| Gender | |||
| Company | Companyname | ||
| Remarks | remarks | usually internal remarks |
Ternair Leads
| Columnname | Description | Remarks | Key |
|---|---|---|---|
| Lead id | Unique ID | Primary key | |
| Group | Predefined list | ||
| Type code | Predefined list | ||
| Type | Predefined list | ||
| Referrer | |||
| Cluster code | Internal clustering code | ||
| Company | |||
| Initials | |||
| First name | |||
| Middle name | |||
| Last name | |||
| Gender | |||
| Foreign key | |||
| Mobile number | |||
| Phone number | |||
| Street | |||
| House number | |||
| House number addition | |||
| Zip code | |||
| City | |||
| Country | |||
| Create date | Date lead entered system |
Ternair Leads Properties
Ternair Webpush Statistics
| Columnname | Description | Remarks | Key |
|---|---|---|---|
| Run id | Unique ID | Big Integer | Primary key |
| Test run | Boolean / true or false | ||
| Block | Internal number email block | ||
| Block description | Description of email block | ||
| Run date | Execution data / time of this run | format “yyyy-mm-dd hh:mm:ss“ | |
| Subject | Subject of message | ||
| Sents | Total number of records | ||
| Denied | Number of records denied (not delivered) | ||
| Audience | Total number of records | ||
| Accepted | Total number of records delivered | ||
| Selection id | Unique Id of selection to which this run belongs | Foreign key | |
| Selection | Name of the selection to which this run belongs | ||
| External reference (selection) | External reference of the selection to which this run belongs | ||
| External reference (campaign) | External reference of the campaign to which this selection belongs | ||
| Campaign id | Unique Id of campaign to which this selection belongs | Foreign key | |
| Campaign | Name of the campaign to which this selection belongs | ||
| CTR | Click through rate | ||
| Segment code | |||
| Offer code | |||
| Total clicks | Total number of clicks | ||
| Distinct clicks | Unique number of clicks |
Meer informatie over Ternair Systeem datamart API is hier te vinden.
