Woopra

https://docs.woopra.com/
Admin
Woopra is a customer analytics platform that tracks user behavior across multiple channels to...
Tokens:85,407
Snippets:794
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Complete Woopra Installation with Tracking (HTML/JavaScript)

Source: https://docs.woopra.com/reference/the-javascript-snippet

This example demonstrates a common implementation of the Woopra Javascript Snippet within the `<head>` section of an HTML document. It includes the initialization snippet, configuration with a project domain, and a call to `woopra.track()` to send a default pageview event. This setup ensures the tracker is installed on every page load.

```html
<head>
  <!-- ... Your head code -->
  <script>
    /*
     * Initialize tracker object on page and create queues for function calls
     * and async load tracker.
     */
    !function(){var t,o,c,e=window,n=document,r=arguments,a="script",i=["call","cancelAction","config","identify","push","track","trackClick","trackForm","update","visit"],s=function(){var t,o=this,c=function(t){o[t]=function(){return o._e.push([t].concat(Array.prototype.slice.call(arguments,0))),o}};for(o._e=[],t=0;t<i.length;t++)c(i[t])};for(e.__woo=e.__woo||{},t=0;t<r.length;t++)e.__woo[r[t]]=e[r[t]]=e[r[t]]||new s;(o=n.createElement(a)).async=1,o.src="https://static.woopra.com/w.js",(c=n.getElementsByTagName(a)[0]).parentNode.insertBefore(o,c)}("woopra"); /*This function is invoked with the tracker object name.  You can change this if you like. See below*/

    /*
     * - There are many options you can pass here to configure the tracker.
     * - The only required option to set is your project name 
     *   in the "domain" property
     */
    woopra.config({
     domain: "mybusiness.com" // This is the minimum required config
    });

    // track pageview
    woopra.track(); // With no arguments, the track funciton will track a default pageview event. See docs for woopra.track() function
  </script>
  
  <!-- ... More of Your head code ... -->
</head>
```

--------------------------------

### Install Woopra JavaScript Tracking Snippet for HubSpot

Source: https://docs.woopra.com/docs/hubspot

This snippet installs the Woopra JavaScript tracking code into the header of your HubSpot website. It initializes Woopra with your domain and tracks initial page views. Ensure the 'mycompany.com' domain is replaced with your actual domain.

```html
<!-- Start of Woopra Code -->
<script>
 (function(){
   var t,i,e,n=window,o=document,a=arguments,s="script",r=["config","track","identify","visit","push","call","trackForm","trackClick"],c=function(){var t,i=this;for(i._e=[],t=0;r.length>t;t++)(function(t){i[t]=function(){return i._e.push([t].concat(Array.prototype.slice.call(arguments,0))),i}})(r[t])};for(n._w=n._w||{},t=0;a.length>t;t++)n._w[a[t]]=n[a[t]]=n[a[t]]||new c
 )("woopra");

 woopra.config({
     domain: 'mycompany.com'
 });
 woopra.track();

</script>
<!-- End of Woopra Code -->
```

--------------------------------

### Track Discount and Promo Code Usage with Woopra

Source: https://docs.woopra.com/docs/ecommerce-tracking

Monitors the application of promotional codes. Capturing the coupon code and validity status helps in measuring the success of marketing campaigns.

```javascript
woopra.track('apply coupon', {
    coupon_code: 'SUMMER16',
    valid: true
});
```

--------------------------------

### Track User Signup Events with Woopra

Source: https://docs.woopra.com/docs/ecommerce-tracking

Records a user signup event along with associated user profile properties. It is recommended to include the user's email address to enable cross-device tracking.

```javascript
woopra.track("signup", {
  name: "John Doe",
  username: "johndoe",
  email: "johndoe@woopra.com",
  address: "XYZ Avenue"
});
```

--------------------------------

### Track Subscription Updates with JavaScript

Source: https://docs.woopra.com/docs/ecommerce-tracking

Logs subscription lifecycle events including creation, modification, and cancellation. It uses Annual Contract Value (ACV) metrics to calculate deltas for revenue reporting.

```javascript
<script>
woopra.track("subscription update", {
  "old acv": 1188.0,
  "new acv": 2388.0,
  "delta": 1200.0,
});
</script>
```

--------------------------------

### Track Product Video View Actions with Woopra

Source: https://docs.woopra.com/docs/ecommerce-tracking

Logs when a user plays a product video. This helps identify the impact of video content on conversion rates by associating video URLs with product metadata.

```javascript
woopra.track('view product video', {
    product_name: 'iPhone 7 Plus',
    product_price: 799.99,
    product_sku: 'A5343S',
    product_category: 'Mobile devices & Accessories',
    product_url: 'https://mystore.com/products/iphone-7-plus',
    video_url: 'https://mystore.com/products/iphone-7-plus#play-video-47'
});
```

--------------------------------

### Track Product Pageview Actions with Woopra

Source: https://docs.woopra.com/docs/ecommerce-tracking

Tracks when a visitor views a specific product page. It captures essential product metadata like name, price, SKU, and category to provide insights into user interest.

```javascript
woopra.track('view product', {
    product_name: 'iPhone 7 Plus',
    product_price: 799.99,
    product_sku: 'A5343S',
    product_category: 'Mobile devices & Accessories',
    product_url: 'https://mystore.com/products/iphone-7-plus'
});
```

--------------------------------

### Track Product Search Actions with Woopra

Source: https://docs.woopra.com/docs/ecommerce-tracking

Tracks user searches on the website to gain insights into popular products and identify potential gaps in product offerings. Requires 'keyword' and 'total_results' properties.

```javascript
woopra.track('product search', {
    keyword: 'iphone',
    total_results: 12
});
```

--------------------------------

### Track Item Checkout Actions with JavaScript

Source: https://docs.woopra.com/docs/ecommerce-tracking

Tracks individual product items during a checkout process to analyze sales by product and category. Requires the Woopra SDK and sends product metadata such as SKU, price, and category.

```javascript
woopra.track('item checkout', {
    product_name: 'iPhone 7 Plus',
    product_price: 799.99,
    product_sku: 'A5343S',
    product_url: 'https://mystore.com/products/iphone-7-plus',
    product_category: 'Mobile devices & Accessories', 
    quantity: 1   
});
 
woopra.track('item checkout', {
    product_name: 'iPhone 7 Plus Case',
    product_price: 49.95,
    product_sku: 'B4723CV',
    product_url: 'https://mystore.com/products/iphone-7-plus-case',
    product_category: 'Mobile devices & Accessories',
    quantity: 2
});
```

--------------------------------

### Making a POST Request with JavaScript

Source: https://docs.woopra.com/reference/getting-started-with-your-api

This snippet demonstrates how to make a POST request to a specified URL using JavaScript's $http service. It includes a success callback function to handle the response. This is useful for sending data to an API endpoint.

```javascript
$http.post('/someUrl', data).success(successCallback);

alert('test');
```

--------------------------------

### Woopra Template Syntax Examples

Source: https://docs.woopra.com/docs/woopra-templates

Demonstrates the basic syntax for Woopra templates, including accessing user, event, and visit properties. The general format is `${<SCOPE>.<property name>}`.

```Woopra Template
${user.first_name}
${event.url}
${visit.browser}
```

--------------------------------

### Track Refund Action in JavaScript

Source: https://docs.woopra.com/docs/ecommerce-tracking

Tracks when an item is refunded, returned, or exchanged. This event requires the 'amount' property to be included, indicating the value of the refund.

```javascript
woopra.track('issue refund', {
    amount: 344.95
});
```

--------------------------------

### Track Signup Actions in JavaScript

Source: https://docs.woopra.com/docs/saas-tracking

Tracks a 'signup' action with associated user properties like email, name, and plan. This is crucial for monitoring user acquisition and optimizing the signup funnel. Ensure properties are lowercase.

```javascript
<script>
woopra.track("signup", {
  company: "My Business",
  name: “John Doe”,
  username: "johndoe",
  email: “johndoe@woopra.com”,
  plan: "Free Trial"
});
</script>
```

--------------------------------

### Track User Logon Events with Woopra

Source: https://docs.woopra.com/docs/ecommerce-tracking

Identifies the user via email and tracks a login event. This helps in monitoring user engagement and authentication patterns.

```javascript
<script>
woopra.identify({
  email: "email@company.com"
})
woopra.track("login");
</script>
```

--------------------------------

### POST /import

Source: https://docs.woopra.com/reference/the-import-api

Bulk import visit data, actions, and visitor properties into a Woopra instance.

```APIDOC
## POST /import

### Description
Imports raw visit data, actions, and visitor properties into the Woopra instance. The request body must be line-separated JSON, where each line represents a single visit or visitor update.

### Method
POST

### Endpoint
/import

### Parameters
#### Request Body
- **visitor** (object) - Required - Contains visitor identifiers and custom properties.
- **actions** (array) - Optional - List of event objects (name, time, properties) performed during the visit.

### Request Example
{"visitor":{"email":"test1@mail.com"}, "actions":[{"time":1444077951001, "name":"purchase", "properties":{"price":20, "currency":"$"}}]}
{"visitor":{"email":"test2@mail.com", "username": "test2"}, "actions":[{"time":1444077951891, "name":"signup", "properties":{"campaign": true}}]}

### Response
#### Success Response (200)
- **status** (string) - Confirmation of successful data ingestion.

#### Response Example
{
  "status": "success",
  "message": "Data imported successfully"
}
```

--------------------------------

### Extend Default Download Extensions

Source: https://docs.woopra.com/reference/woopraconfig

Demonstrates how to override the default list of tracked file extensions by concatenating new values to the existing configuration array during initialization.

```javascript
woopra.config({
  domain: 'woopra.com',
  initialized: function () {
    woopra.config(
      'download_extensions',
      woopra.config('download_extensions').concat('xml')
    );
  }
});
```

--------------------------------

### Track Checkout and Purchase Events with Woopra

Source: https://docs.woopra.com/docs/ecommerce-tracking

Records a checkout event with detailed financial properties such as total amount, tax, and order ID. This is critical for monitoring revenue and conversion success.

```javascript
woopra.track('checkout', {
    total_items: 3,
    discount_amount: 0,
    tax_amount: 154.23,
    shipping_amount: 12.95,
    total_amount: 1430.43,
    order_id: '22bksmkdz4m9ds'
});
```

--------------------------------

### Track Add Payment Method Events with Woopra

Source: https://docs.woopra.com/docs/ecommerce-tracking

Tracks when a user adds a payment method to their account. Including the payment type property allows for analysis of preferred payment methods.

```javascript
woopra.track('add payment method', {
    type: 'Visa'
});
```

--------------------------------

### Configure Visitor and Session Properties

Source: https://docs.woopra.com/reference/track-ce

These properties allow for manual overrides of visitor metadata. By defining these parameters, you can control the session timeout, specify the visitor's IP, or manually set device and browser information instead of relying on auto-detection.

```json
{
  "referer": "https://www.google.com",
  "ip": "127.0.0.1",
  "timeout": 30000,
  "browser": "chrome",
  "os": "Windows 10",
  "device": "mobile",
  "app": "server event"
}
```

--------------------------------

### Track Profile Update Events with Woopra

Source: https://docs.woopra.com/docs/ecommerce-tracking

Updates user profile information in Woopra and triggers a 'profile update' event. Useful for tracking changes to user preferences or contact details.

```javascript
woopra.identify({
  fname: "First name",
  lname: "Last name",
});
 
woopra.track("profile update");
```

--------------------------------

### Track Pageview Event via API

Source: https://docs.woopra.com/reference/track-ce

This example demonstrates the structure of a pageview event request. It is recommended to include 'ce_url' and 'ce_title' to ensure proper integration with Woopra's built-in reporting interface.

```javascript
{
  "project": "dev.woopra.com",
  "instance": "woopra",
  "screen": "2560x1440",
  "language": "en-US",
  "app": "js-client",
  "referer": "www.google.com",
  "cookie": "5e0saOzmYfgh4q",
  "event": "pv",
  "ce_title": "Real-time Customer Analytics - Woopra",
  "ce_domain": "www.woopra.com",
  "ce_url": "/welcome-page",
  "ce_uri": "https://www.woopra.com/welcome-page"
}
```

--------------------------------

### Track Blog Article Views and Comments

Source: https://docs.woopra.com/docs/ecommerce-tracking

Measures engagement with blog content by tracking article views and user comments. This data is useful for blog attribution and understanding content performance.

```javascript
woopra.track("article view", {
  title: "Blog post title",
  url: "https://blog.companya.com/we-are-awesome",
  author: "John Smith",
  category: "News",
  published_on: 125234234234
});

woopra.track("article comment", {
  comment: "Great article"
});
```

--------------------------------

### Track Mobile Application Actions

Source: https://docs.woopra.com/docs/saas-tracking

Illustrates tracking mobile-specific events including app loads and view changes. It also shows how to include attribution data like campaign source and medium as event properties.

```javascript
woopra.track("mobile load", {
  campaign_name: "July 2017 Promo",
  campaign_source: "facebook",
  campaign_medium: "ad"
});

woopra.track("mobile view", {
  title: "Dashboard"
});

woopra.track("create widget", {});
```

--------------------------------

### Track Application Error Actions with JavaScript

Source: https://docs.woopra.com/docs/ecommerce-tracking

Captures user-facing errors such as form validation failures or application exceptions. This data helps customer success teams identify and resolve recurring issues.

```javascript
<script>
woopra.track("form error", {
  form: "signup form",
  error: "Email already registered"
});
 
woopra.track("form error", {
  form: "login form",
  error: "Wrong username or password"
});
 
woopra.track("app error", {
  app_version: "1.2",
  error_code: 500,
  error: "Failed to download resource A"
});
</script>
```

--------------------------------

### Importing Visits via Line-Separated JSON

Source: https://docs.woopra.com/reference/the-import-api

Demonstrates the format for bulk importing visit data, including visitor identification and nested action events. Each line represents a distinct session, containing a visitor object and an array of actions performed.

```text
{"visitor":{"email":"test1@mail.com"}, "actions":[{"time":1444077951001, "name":"purchase", "properties":{"price":20, "currency":"$"}}]}
{"visitor":{"email":"test2@mail.com", "username": "test2"}, "actions":[{"time":1444077951891, "name":"signup", "properties":{"campaign": true}}]}
```
Tokens:
Raw