Thank-You Page Tracking

This page is Part 2 in a 3-part series on how to develop a custom integration with Katalys.

1. Landing Page Tracking

2. Thank-You Page Tracking (this page!)

3. Order Status Reporting

Katalys requires Advertisers to include our tracking pixel 1) on Landing Pages (for fraud detection, user verification, and direct linking) and 2) on Thank-You pages (for capturing conversions). On this page, we will describe considerations for placing the Katalys Tracking Script on Thank-You pages, and how to send additional properties into the Katalys Marketing Platform.

Basics

Add our tracking JavaScript snippet to your post-sale Thank-You page, after the customer has completed an order. The tracking snippet must come before the order-reporting snippet.

Get your script on the Katalys Platform’s Integrations page →

Your Katalys Tracking Script should be placed higher on the page and/or run before you execute any of the below examples.

Secondly, report a custom event by defining event parameters in a call to our SDK. Most clients prefer to see their own Order ID in the Katalys Marketing reporting, so we highly recommend you set the Required Fields in your snippet. See below for examples and available fields.

Ecommerce Example

Reporting an ecommerce order to Katalys requires fields like order_id. The script will look similar to the code below.

<script>
_revoffers_track.push({
  action: "convert",
  order_id: "{{YOUR_ORDER_ID}}",
  sale_amount: "{{YOUR_SALE_AMOUNT}}",
  subtotal_amount: "{{YOUR_SUBTOTAL_AMOUNT}}",
  email_address: "{{CUSTOMER_EMAIL}}",
  discount_1_code: "{{DISCOUNT_CODE_USED}}",
});

// ... see below for all field definitions
</script>

Recommended Fields

• order_id:   {string}  example: “12345”
  We use this field to disambiguate orders placed by your customers. It is important that this value be globally unique for your e-commerce account!

• sale_amount:  {float|string}  example: 25.67
  This should be a numeric value without currency.

• subtotal_amount:  {float|string}  example: 24.95
  This is sale_amount minus shipping and tax.

• email_address:   {string}  example: “email@example.com”
  We use this field to disambiguate customers.  Without this field, we cannot perform any special logic like double-conversion avoidance or customer-exclusion.

• Discount fields:
  For each applied discount or coupon, include the fields discount_X_code and discount_X_amount.

  • discount_1_code:  {string}  example: “REVOFFERS_EXAMPLE”

  • discount_1_amount:  {float|string}  example: “1.50”

See all available fields on the Order Status Reporting page >>

This example shows how your completed script might appear for an order that contains a single coupon:

<script>
_revoffers_track.push({
    action: "convert",
    order_id: "12345",
    sale_amount: 25.67,
    subtotal_amount: 24.95,
    email_address: "email@example.com",
    discount_1_code: "REVOFFERS_EXAMPLE",
    discount_1_amount: 1.50,
});
</script>

Lead-Capture Example

This example illustrates a use-case where no sale occurred, but customer information was gathered. Replace the text {{CUSTOMER_EMAIL}} below with the email address of the lead.

<script>
_revoffers_track.push({
  action: "convert",
  order_id: _revoffers_track.sid,
  email_address: "{{CUSTOMER_EMAIL}}",
})
</script>

Minimal Example

This example records a site-session as being a “converter”, but provides no other details to Katalys for optimizing your program. This example is only suitable for basic conversion tracking use cases such as signups.

<script>
_revoffers_track.push("convert")
</script>

Validating your Thank-You Script

You must confirm that the script is running by executing a test order on your website, and making sure that the script is reporting information to Katalys correctly. The Katalys JavaScript tag is easy to debug by using any browser debugging tools, such as the Chrome DevTools window.

• Open your website inside of Chrome, and open up the DevTools (documentation).

• Click on the “Network” panel to view all the network requests being made by your website.

• Complete an order on your website with the DevTools open. Stop on your Thank You page, after you’ve completed your testing order.

• Search for revoffers or _tr. Find a ping to https://db.revoffers.com/v2/_tr.

• Select the ping you wish to inspect, and click on the “Payload” tab on the right. This is the raw information that is being sent to the server. You should see the order data, such as order_id, defined in the Payload.

  

Using the “Payload” tab, compare the data visible on the screen to the data you expect to be submitted to the server. Follow the table below for next steps.

Appendix

Alternate Implementation

We have an alternate implementation that can allow tracking of specific events. To activate this, use the following script to initialize the _revoffers_track global object. Then each call to .push() can use multiple arguments. This is used to track custom events and offer session-state in custom integrations.

<script src="{{YOUR-URL-FROM-Katalys-Platform}}" async></script>
<script>
window._revoffers_track = window._revoffers_track || function(){var a=[],b=a.push;a.push=()=>b.call(a,arguments);return a}();
_revoffers_track.push("merge", { ... });
_revoffers_track.push("event", { ... });
</script>

Available Fields

The JavaScript implementation and server-to-server implementation allow you to set the same fields. In your Thank-You page snippet, you can set any field available.

See all available fields on the Order Status Reporting page >>