Tracking
From Elertz API
Contents |
Tracking Statistics
The following section assumes the partner wishes to track elertz subscriptions themselves rather than use the built in tracking facility within the elertz partner site control panel.
In order to track activity related to an elertz outside the built in control panel statistics the partner must:
- Provide a URL to which is able to parse http ‘GET’ method to receive the event notification.
- Specify the tracking URL in the ‘My Accounts’ section of the elertz control centre.
- Add a ‘tracking_id’ parameter and alphanumeric value to the elertz linking code. This can done using the parameter provided under the advanced options or by manually adding it to the elertz subscription linking code.
The tracking URL will be sent the following http 'GET' variable parts:
- elertz tracking URL
- Tracking ID
- Webmaster ID (the partner ID)
- Schema ID
- elertz name
- elertz status
- Branding ID
- Installation IP address
|
NOTE! The notification messages do not come directly from the subscribers browser to the partner, they are first sent and logged in the elertz database, and passed a few seconds later to the partner’s tracking URL from the elertz servers. |
|
NOTE! The webmaster_id, schema_id, ez_name, ez_status, brand_id (passed as 0 if none set) and install_id (guide string value) parameters are always sent with every notification. |
Elertz tracking URL
- Name: N/A
- Type: URL
This URL is the server script that is used to notify partners of a change to a subscribed elertz from the subscriber. This is called with all the requisite parameters and values. This script is called using an http GET.
Tracking ID
- Name: tracking_id
- Type: Text, max 50 char
The partner user login/tracking id string is provided to allow the partner to track the activity of any elertz subscription. An id is provided for in each elertz subject and can be used within the statistics to monitor subscriptions generated from different parts of the web site. This parameter returns the partner user login/tracking id for the elertz subscription that this notification relates to. In our example we have: & tracking_id=12345 In this example the tracking id string for this is ‘12345’ for the elertz this notification relates to.
Webmaster ID/Partner ID
Name: webmaster_id Type: Number The webmaster_id is a unique identifier supplied to each registered partner. The partner will receive this id when they register, in their registration welcome email. This parameter returns the partner id for the elertz subscription that this notification event relates to. In this case the value of the ‘example’ partner is: & webmaster_id=18 The ‘example’ webmaster identifier is 18 for the elertz this notification relates to.
Schema ID
- Name: schema_id
- Type: Number
The schema_id is unique integer that is the identifier for each configured elertz schema. This parameter returns the schema id for the elertz subscription that this tracking event relates to. For example this would be: & schema_id=135. Here the schema_id is 135 for the elertz this notification relates to.
Elertz name
- Name: ez_name
- Type: Text
This parameter supplies the full name of the elertz subscription that this tracking event relates to. Following our example this would be: & elertz_name=Ferrari less than $100K Here the elertz this notification relates to an elertz subscription with the name of ‘Ferrari less than $100K’.
Elertz status
- Name: ez_status
- Type: add | delete | install | uninstall
This parameter characterises the type of event that occurred that this tracking event relates to. Following our example this would be: & ez_status=Deleted Here the notification shows that the relevant elertz has been deleted by the subscriber.
Brand ID
- Name: brand_id
- Type: Text
It is possible to define special brandings for a toolbar and each of these set of branding attributes has unique numeric branding id. This parameter will return any branding id’s that were set. For example this would be:
&brand_id=76
Installation IP address
- Name: install_ip
- Type: IP Address
This parameter supplies the IP address of the client from which this notification event originated. Following our example this would be: & install_ip=85.64.31.158
