SYSTEM

Kind: global class

• SYSTEM
  • new SYSTEM(key, token, account, application)
  • .consumer(fp, con) ⇒ Object
  • .trackEvent(fp, category, action, label, value)
  • .trackEventByID(id, category, action, label, value)

new SYSTEM(key, token, account, application)

| Param | Type | Description | | --- | --- | --- | | key | String | The SYSTEM API key https://app.getsystem.de/#/config/api | | token | String | The SYSTEM API token https://app.getsystem.de/#/config/api | | account | String | The Trackingprofile ID. Can be found here https://app.getsystem.de/#/config/properties | | application | String | The Application Name |

systeM.consumer(fp, con) ⇒ Object

Create or Update a Consumer

Kind: instance method of SYSTEM
Returns: Object - the SYSTEM con object

| Param | Type | Description | | --- | --- | --- | | fp | String | The fingerprint, can be found in the session cookie sys_fp | | con | Object | The new consumer object | | con.sysfp | String | the fingerprint, can be found in the session cookie sys_fp (search string for update) | | con.ext_id | String | the ID from your system | | con.sysac | String | the Tracking Profile | | con.company | String | the company | | con.title | String | the title | | con.salutation | String | the salutation | | con.first_name | String | the first name | | con.last_name | String | the last name | | con.email | String | the E-Mail Adress (search string for update) | | con.street | String | the street | | con.zip | String | the zip | | con.city | String | the city | | con.country | String | the country | | con.state | String | the state | | con.phone | String | the phone number | | con.fax | String | the fax number | | con.cell | String | the mobile number | | con.newsletter | Boolean | General flag for newsletters | | con.privacy | Boolean | the consumer has accepted the privacy rules | | con.website | String | the website | | con.doi | Boolean | the consumer has approved his mail adress | | con.doi_date | String | the date when the consumer has approved his mail adress | | con.doi_ip | String | the ip with wich the consumer has appoved his mail adress | | con.status | String | the status | | con.sales_stage | String | the sales stage | | con.contact_status | String | the contact status | | con.note | String | a note field | | con.affiliate | Boolean | comes over an affiliate | | con.affiliatedata | Object | the affiliate data | | con.affiliate_status | String | the lead status e.g. valid /invalid | | con.syssource | String | the source | | con.sysmedium | String | the medium | | con.systerm | String | the term | | con.syscontent | String | the content | | con.systopic | String | the topic | | con.sysregion | String | the region | | con.syscampaignname | String | the campaign name |

systeM.trackEvent(fp, category, action, label, value)

Track an event http://docs.curesoft.de/display/SYSDOCS/Senden+eines+Events

Kind: instance method of SYSTEM

| Param | Type | Description | | --- | --- | --- | | fp | String | The fingerprint, can be found in the session cookie sysfp | | category | String | The event category | | action | String | The event action | | label | String | The event label | | value | String | The event value |

systeM.trackEventByID(id, category, action, label, value)

Track an event by the SYSTEM Consumer ID http://docs.curesoft.de/display/SYSDOCS/Senden+eines+Events

Kind: instance method of SYSTEM

| Param | Type | Description | | --- | --- | --- | | id | String | The SYSTEM Consumer ID | | category | String | The event category | | action | String | The event action | | label | String | The event label | | value | String | The event value |