Difference between revisions of "ConversionRuler Tracking API"

Revision as of 19:34, 27 April 2016

ConversionRuler supports back-end calls to our server from your server, provided that your web site is willing to manage aspects of the user session and cookie management. This functionality is intended for advanced developers who understand cookies, the HTTP protocol, URL escaping, and how to retrieve various aspects of browser state.

The main call to ConversionRuler is:

https://www.conversionruler.com/bin/tracker.php

All parameters are passed as a query string to the above call.

The following parameters are accepted to this call:

Parameter	Type	Required	Description	Examples
siteid	Text	Yes	The Site ID assigned to your site. Should remain the same for your entire site. Usually a numeric value (integer) but may be extended in the future to support text values as well.	19 935
ip	IPv4	No	If supplied, the IP address of the browser accessing your site. If not supplied, the IP address of the client making the request (e.g. the browser).	125.63.12.52 192.168.0.12 8.5.1.2
user_id	32-character hexadecimal string	Yes	The unique identifier for this user on your site. This identifier should persist for this visitor for as long as possible and be set as a cookie in the user's browser and passed through for each call to the tracking script.	c4ca4238a0b923820dcc509a6f75849b eccbc87e4b5ce2fe28308fd9f2a7baf3
session_id	32-character hexadecimal string	Yes	The unique identifier for this user's session on your site. This identifier should persist for this visitor for 30 minutes after their most recent page view. A new session ID should be generated after 30 minutes if inactivity. This can be done by setting the session cookie to expire 30 minutes after the current time, and creating a new session ID for the user if it does not exist.	e4da3b7fbbce2345d7772b0674a318d5 8f14e45fceea167a5a36dedd4bea2543
useragent	string	Yes	The user agent string from the client's browser.	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36 Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 10.0; WOW64; Trident/7.0; Touch; .NET4.0C; .NET4.0E; .NET CLR 2.0.50727; .NET CLR 3.0.30729; .NET CLR 3.5.30729; Tablet PC 2.0)
page_url	URL	Yes	The URL of the page where a landing or action occurred.	http://www.example.com/store/buy-now https://conversion.marketruler.com/signup.php
top_page_url	URL	No	For Frame-based sites, the URL of the topmost page where a landing or action occurred.	http://www.example.com/store/buy-now https://conversion.marketruler.com/signup.php
referrer	URL	No	The referring page for the current page. Equivalent to the Referrer HTTP header for web pages.	http://www.example.com/store/checkout https://www.conversionruler.com/pricing/
craction	string	No	The code name of the action which occurred on the page in question. These should be configured in ConversionRuler's actions management. If not supplied the page is treated as a landing page.	order thank-you 5 newsletter
same	boolean	No	0 or 1. Whether landings should be recorded on pages which originate from the same domain.	0 1
v	integer	Yes	Snippet version. The current snippet version is 4444.	4444

@@ Line 64: / Line 64: @@
 | string
 | '''No'''
-| The code name of the action which occurred on the page in question. These should be configured in ConversionRuler's actions management.
+| The code name of the action which occurred on the page in question. These should be configured in ConversionRuler's actions management. If not supplied the page is treated as a landing page.
 | order<br />thank-you<br />5<br />newsletter
 |-