Market Ruler HelpDifference between revisions of "ConversionRuler Tracking API"
From Market Ruler Help
| Line 5: | Line 5: | ||
https://www.conversionruler.com/bin/tracker.php | https://www.conversionruler.com/bin/tracker.php | ||
| − | All parameters are passed as a query string to the above call. | + | All parameters are passed as a query string to the above call. |
The following parameters are accepted to this call: | The following parameters are accepted to this call: | ||
| Line 11: | Line 11: | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| − | ! Parameter !! Required !! Description !! Examples | + | ! Parameter !! Type !! Required !! Description !! Examples |
|- | |- | ||
| − | | <span | + | | <span class="code">siteid</span> |
| + | | Text | ||
| '''Yes''' | | '''Yes''' | ||
| − | | The Site ID assigned to your site. Should remain the same for your entire site. | + | | 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<br />935 | | 19<br />935 | ||
|- | |- | ||
| − | | <span | + | | <span class="code">ip</span> |
| + | | IPv4 | ||
| ''No'' | | ''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''<br />192.168.0.12<br />8.5.1.2 |
| + | |- | ||
| + | | <span class="code">user_id</span> | ||
| + | | 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 browsers and passed through for each call to the tracking script. | ||
| + | | c4ca4238a0b923820dcc509a6f75849b<br />eccbc87e4b5ce2fe28308fd9f2a7baf3 | ||
| + | |- | ||
| + | | <span style="code">session_id</span> | ||
| + | | 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<br />8f14e45fceea167a5a36dedd4bea2543 | ||
|} | |} | ||
| + | |||
| + | [[Category:ConversionRuler Features]] | ||
Revision as of 19:08, 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 browsers 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 |