Resource types
This table provides information about the meaning of the values in the resource_type_id column of the remaining tables. No further authorizations are required.
table=resourcetypes
|
Column |
Type |
Description |
|
id |
int |
Id of the resource type |
|
name |
string |
Name of the resource type, is influenced by the parameter lang |
Tracking types
This table gives information about the meaning of the values in the column type of the tracking history table. No further authorizations are required.
table=trackingtypes
|
Column |
Type |
Description |
|
id |
int |
Id of the link type |
|
name |
string |
Name of the tracking type, is influenced by the parameter lang |
Clients
This table provides a list of all clients including information whether the client can be accessed.
table=customers
|
Column |
Type |
Description |
|
id |
int |
Id of the link type |
|
name |
string |
Name of the tracking type, is influenced by the parameter lang |
|
accessible |
bool |
true if the client can be accessed with this API user. Otherwise false |
Configured scoring groups of the current client
This table returns the configured scoring groups of the client in which the user is currently located.
The right scoring is required.
table=scoringgroups
|
Column |
Type |
Description |
|
id |
int |
Id of the scoring group |
|
name |
string |
Name of the scoring group |
Pools of the current client
This table returns the list of pools of the client in which the user is currently located. The Display pool authorization is required.
table=pools
|
Column |
Type |
Description |
|
id |
int |
Id of the pool |
|
name |
string |
Name of the pool |
|
profile_count |
int |
Number of profiles in the pool |
|
unconfirmed_profiles |
int |
Number of unconfirmed profiles in the pool |
|
unsubscribed_profiles |
int |
Number of logged off profiles in the pool |
|
erroneous_profiles |
int |
Number of faulty profiles in the pool |
Forms and form aliases of the current client
This table returns the list of forms and form aliases of the client in which the user is currently located. The Display form and Display form alias permission is required.
table=forms
|
Column |
Type |
Description |
|
id |
int |
Id of the form or form alias |
|
name |
string |
Name of the form or form alias |
|
parent_id |
int/zero |
For the form null, for the form alias the id of the parent form |
|
impressions |
int |
Number of impressions of the form or form alias |
|
submissions |
int |
Number of successful entries in the form or form alias |
|
pool_id |
int |
Id of the pool to which the form or form alias is assigned |
|
is_alias |
bool |
false for the form, true for the form alias |
LeadPages of the current client
This table returns the list of lead pages of the user customer or client with the ID customer_id. The Display LeadPage permission is required.
table=leadpages
|
Column |
Type |
Description |
|
id |
int |
Id of the LeadPage |
|
name |
string |
Name of the LeadPage |
|
resource_type_id |
int |
Resource Type ID of the lead page |
Profiles of a pool
This table returns the profile data of a pool, which is defined using the parameter pool_id
table=profiles
The columns returned correspond to the pool configuration
Dispatches of the current client
This table returns the list of sendings of the client in which the user is currently located. The Display eMailing (dispatch) permission is required.
table=mailings
|
Column |
Type |
Description |
|
id |
int |
Id of dispatch |
|
name |
string |
Name of the shipment |
|
address |
int |
number of addressees |
|
recipients |
int |
Number of recipients |
|
conversions |
int |
Number of conversions |
|
conversion_sum |
int |
Sum of the int values of all conversions |
|
conversion_sum_float |
float |
Sum of the float values of all conversions |
|
clicks |
int |
Number of clicks |
|
click_rate |
float |
Click rate |
|
click_rate_relative |
float |
Relative click rate |
|
click_rate_multiple_relative |
float |
Relative multiple click rate |
|
clicks_unique |
int |
Unique clicks |
|
opening_rate |
float |
Opening rate |
|
opening_rate_por |
float |
Opening rate POR |
|
opening_rate_multiple |
float |
Multiple opening rate |
|
bounce_rate |
float |
Bouncerate |
|
campaign_id |
string |
Campaign Id of the mailing |
|
sendout_starttime |
datetime |
Start time of the dispatch |
|
sendout_endtime |
datetime |
End time of dispatch |
|
sendout_triggertime |
datetime |
Date of preparation of the dispatch |
|
unsubscriptions |
int |
Number of cancellations of the dispatch |
|
unsubscription_rate |
float |
Logoff rate of the dispatch |
|
targetgroup_id |
int |
ID of the shipping target group used |
|
targetgroup_name |
string |
Name of the shipping target group used |
Shipping history
This table returns the list of all shipments and the recipients. The Show eMailing permission is required.
table=newsletterendlogs
|
Column |
Type |
Description |
|
resource_id |
int |
Id of the dispatch / mailing |
|
profile_id |
int |
Id of the sent profile |
|
sent_date |
datetime |
date of service |
|
mail_size |
int |
Size of the dispatch / mailing in bytes |
|
state |
int |
status of dispatch |
state
0 = Queue 1 = Successfully delivered 2 = HB 3 = SB 10 = First Retry 11 = Second Retry 12 = Error 20 = Successful print mail dispatch 21 = Faulty print mail dispatch
Activityscoring history of the current client
This table returns the score entries of all profiles of the client in which the user is currently located. The Scoring permission is required.
table=scoringhistory
|
Column |
Type |
Description |
|
id |
int |
Id of the scoring entry |
|
timestamp |
datetime |
Time at which the entry was created |
|
resource_id |
int |
Id of the resource, by which the entry was initiated |
|
resource_name |
string |
Name of the resource, by which the entry was initiated |
|
resource_type_id |
int |
Type of resource that caused the entry |
|
scoringgroup_id |
int |
ID of the scoring group to which the entry is assigned |
|
profile_id |
int |
Id of the profile to which the entry is assigned |
|
scoring_value |
int |
Scoring value |
|
scoring_type_id |
int |
Id of the scoring type |
|
tracking_id |
int |
Id of the tracking |
|
description |
string |
Description text of the score |
Scores of all profiles
Scores of all profiles across all scoring groups of the current client
This table returns the current scoring values of all profiles across all scoring groups of the client in which the user is currently located.
The right scoring is required.
table=profilescores
|
Column |
Type |
Description |
|
id |
int |
Pseudo ID of the entry in the form <profile_id>_<scoring_group_id> |
|
profile_id |
int |
Id of the profile to which the entry is assigned |
|
scoring_group_id |
int |
ID of the scoring group to which the entry is assigned |
|
profile_score |
int |
Current profile score Value of the profile in the scoring group |
|
activity_score |
int |
Current Activityscore Value of the profile in the scoring group |
Tracking history of all profiles of the current client
Tracking history of all profiles of the current client
This table provides the detailed tracking history of all profiles of the client in which the user is currently located. No special authorization is required.
table=trackinghistory
|
Column |
Type |
Description |
|
id |
int |
Id of the tracking entry |
|
resource_id |
int |
Id of the resource, by which the entry was initiated |
|
resource_name |
string |
Name of the resource, by which the entry was initiated |
|
resource_type_id |
int |
Type of resource that caused the entry |
|
sub_resource_id |
int |
Id of the sub-resource that caused the entry (e.g. article) |
|
sub_resource_name |
string |
Name of the sub-resource that initiated the entry (e.g. article) |
|
sub_resource_type_id |
int |
Type of sub-resource that caused the entry |
|
sub_url |
string |
URL of the link, if available |
|
profile_id |
int |
Id of the profile to which the entry is assigned |
|
type |
int |
Type Id of the entry |
|
timestamp |
datetime |
Date of entry |
|
referrer_domain |
string |
Referrer, if available |
Profile changelog
This table provides the profile change log, in which permission changes and form activities are stored. A pool_id
table=profilechangelogs
|
Column |
Type |
Description |
|
form_id |
int |
Id of the form involved |
|
profile_id |
int |
Id of the profile involved |
|
permission |
int |
The permission that was set during the action |
|
update_mode |
int |
Type of update |
|
ip |
string |
IP address from which the activity was initiated |
|
date |
int |
Timestamp of the change |
|
|
string |
E-mail address of the profile involved |
Update Modes
- 0 = entry,
- 1 = Update,
- 2 = Update (unique criterion),
- 3 = carry out,
- 4 = Tracking revocation
Permission Modes
- 1 = Enter for double opt-in,
- 2 = Discharge,
- 3 = Enter as opt-out,
- 4 = Enter as opt-in,
- 5 = Confirm as double opt-in,
- 6 = Login only
Campaign Activities
This table provides the profile activities of a campaign. This can be used to Evaluate movements within a campaign.
table=campaign-profile-history
|
column |
Type |
Description |
|
id |
int |
Unique id of the activity |
|
config_version |
string |
UUID of the configuration version at the time of activity |
|
state_id |
string |
UUID of the affected campaign element |
|
profile_id |
int |
ID of the affected profile |
|
timestamp |
string |
Time at which the profile left the node |
|
result |
int |
Status of the activity (1 = successful/positive, 0 = negative) |
The UUIDs of the configuration version as well as the campaign elements can be retrieved through the SOAP methods "getConfiguration" as well as "getConfigurationVersions" can be obtained.