Documentation

Integration

To start using Beetle Eye you need to send your data to our API endpoint. Here is an example with cURL

  
 curl -X POST \
  https://app.beetle-eye.com/api/v1/add-form \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{  
   "api_key":"[YOUR_API_KEY]",
   "call_mode":"production",
   "form_key":"[FORM_KEY]",
   "source":"[SOURCE_ID]",
   "cookie_key":"[COOKIE_KEY]",
   "post_url":"[YOUR_URL]",
   "ip":"[SOURCE_IP]",
   "data":{  
     "form_field1": "value1",
     "form_field2": "value2", 
      .......................     
   }
 }'
 

 
curl -X POST \
  https://app.beetle-eye.com/api/v1/add-sale \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
  "api_key": "[YOUR_API_KEY]",
  "sale_id": "[UNIQUE SALE ID]",
  "call_mode": "production",
  "source": "[SOURCE_URL]",
  "cookie_key": "[COOKIE_KEY]",
  "lead": {
          "email": "[EMAIL]",
          "first_name": "[FNAME]",
          "last_name": "[LNAME]", 
          "county": "[COUNTY]",
          "fax": "[FAX]",
          "company_address": "[COMPANY_ADDRESS]",
          "company_phone": "[COMPANY_PHONE]",
          "company_city": "[COMPANY_CITY]",
          "company_state": "[COMPANY_STATE]",
          "company_email": "[COMPANY_EMAIL]",
          "company_country": "[COMPANY_COUNTRY]"
          ..................
          "[custom_field_id]": "[CUSTOM_DATA"]   
          /* You can find the ID's in the first column of the SDL Editor */
  },
  "data": [{
          "cc_name": "[CC_NAME]",
          "daily_rate": [9.999999999999999999999999999999999],
          "order_date": "[Y-m-d h:i:s]", 
          "custom_data": {
           /*list here all the custom fields you want to have available with sale record creation as key - value pairs. */
          }
        /* repeat this line as many items there are into a single sale. check eSDL list below*/
   ]
 }'

In conjunction with the API calls you must send to record your data and in order to use Beetle Eye tracking on your website you will need to embed the following piece of code above the closing body tag of all of your pages. Its important to note that the API calls you send and the JS lib work together and you must have them both working if you wish to receive all the data properly.

You will need 2 variables from your Beetle Eye account: your Api Key and your Source Id. The API key assocciated with your account can be located when you click on the top right-hand corner on your name and expand your profile menu, then click the "API" submenu and new screen will load with your account id. The Source Id can be located when you click on the left hand side navigation under Sources/All Sources. You will land on page that shows a list of all your available sources. The second column in this table is called "Key" and that is the value you need for your Source Id variable.

//BeetleEye Analytics : START

    var element = document.createElement("script");
    element.setAttribute('type', 'text/javascript');
    element.src = (document.location.protocol == "https:" ? "https:" : "http:") + "//app.beetle-eye.com/js/client-libs/beanalytics.min.js";
    element.async = true;

    var options = {
        apikey: "YOUR_API_KEY_HERE",
        source_id: "YOUR_SOURCE_ID_HERE",
        withEvents: true,
        debug: false
    }

   element.onload = function()
   {
       var _be = new beTracking();
       _be.setOptions(options);

   };

   var s = document.getElementsByTagName('script')[0];
   s.parentNode.insertBefore(element, s);
//BeetleEye Analytics : END

//BeetleEye Analytics : START

    var element = document.createElement("script");
    element.setAttribute('type', 'text/javascript');
    element.src = (document.location.protocol == "https:" ? "https:" : "http:") + "//app.beetle-eye.com/js/client-libs/beanalytics.min.js";
    element.async = true;

    var saleObj = {
        apikey: "YOUR_API_KEY_HERE",
        source_id: "YOUR_SOURCE_ID_HERE",
        sale_id: "UNIQUE_SALE_ID_NUMBER",
        debug: false,
        call_mode: "production",
        cookie_key: "random-cookie-key",
        order_date: "YYYY-MM-DD",
	lead: {
	  address_line: "",
          city: "",
          company_name: "",
          country: "",
          email: "",
          first_name: "",
          last_name: "",
          phone: "",
          state: "",
          zip: "" 		
        },
        data: [{
           total_cost: "", 
           total_cost_with_tax: ""
           /* list any of the eSDL fields here as key: 'value' pairs */
           /* every item sold must be in its own array */
        }]
    }

    element.onload = function() {
        var _be = new beTracking();
        _be.addSale(saleObj);
    };

    var s = document.getElementsByTagName('script')[0];
    s.parentNode.insertBefore(element, s);

// BeetleEye Analytics : END

The Standard Data List Editor is created to help you manipulate custom data key - value pairs. The fields created with the SDL Editor have 2 characteristics: numerical ID and text based name. The ID is unique and it's assigned automatically from the system. You only need to input a common name for your field. Once the field is created you will see it in your Forms editor underneath the "Assigned Field Name" section and you can start assigning incoming form data fields to it, also note that you can also use these fields for incoming sales data.

There are two types of standard data that Beetle Eye is capable of processing out of the box. Of course you can create custom fields and you are not restricted to the standard fields.

The SDL ( Standard Data List)

The e-commerce SDL is the standard list of fields accepted for sales.

If you want to do e-commerce tracking on your site or with a 3rd party vendor that allows your to put tracking code on their site you will need this code. Please check above on how to locate your api and source id keys.