Other

Session Started

It is good practice to track when a user starts a new session. This would normally happen on the first page view of your website or when they open your app.

You can send any custom attributes along with this

Interface

interface SessionStart {
    event: 'Session Started',
    properties?: { ...custom }
}

JavaScript API

fp360.track('Session Started', {
    // optionally send custom attributes
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Session Started",
  "properties": {
    // optionally send custom attributes
  }
}

Session Ended

You can send any custom attributes along with this.

Interface

interface SessionStart {
    event: 'Session Ended',
    properties?: { ...custom }
}

JavaScript API

fp360.track('Session Ended', {
    // optionally send custom attributes
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Session Ended",
  "properties": {
    // optionally send custom attributes
  }
}

Location Visited

Indicate an offline location has been visited such as a store.

• $location - Location

Interface

Interface

interface LocationVisited {
  event: 'Location Visited'
  properties: {
    $location: Location
  }
}

JavaScript API

Example

fp360.track('Location Visited', {
  $location: {
    id: "234789",
    name: "Fanplayr HQ",
    country: "United States",
    countryCode: "US",
    region: "California",
    city: "Palo Alto",
    postalCode: "94301",
    street: "725 Alma Street",
    text: "725 Alma Street, Palo Alto, CA 94301",
    latitude: 37.44178713736534,
    longitude: -122.16064940120228
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Location Visited",
  "properties": {
    "$location": {
      "id": "234789",
      "name": "Fanplayr HQ",
      "country": "United States",
      "countryCode": "US",
      "region": "California",
      "city": "Palo Alto",
      "postalCode": "94301",
      "street": "725 Alma Street",
      "text": "725 Alma Street, Palo Alto, CA 94301",
      "latitude": 37.44178713736534,
      "longitude": -122.16064940120228
    }
  }
}

Offline Purchase Completed

Indicate a purchase was completed offline, such as in store.

• $order - Order

Interface

Interface

interface OfflinePurchaseCompleted {
  event: 'Offline Purchase Completed'
  properties: {
    $order: Order
  }
}

JavaScript API

Example

fp360.track('Offline Purchase Completed', {
  $order: {
    orderNumber: "34859456045",
    revenue: 73.40,
    discount: 10.00,
    discountCode: "10OFF",
    tax: 5.00,
    shipping: 7.00,
    currency: "USD",
    salesperson: "Jane",
    cashier: "John",
    products: [
      {
        id: "23489023",
        sku: "23489023",
        name: "Red Shoes",
        categories: [
          "Shoes & Accessories > Shoes",
          "Shoes & Accessories > Shoes > Women Shoes"
        ],
        price: 49.95,
        quantity: 1,
        url: "https://example.com/products/23489023",
        imageUrl: "https://example.com/products/23489023.jpg",
        currency: "USD",
        variant: "Striped",
        color: "Red",
        size: "US 8",
        brand: "Nike"
      }
    ],
    location: {
      id: "243850934",
      name: "Fanplayr HQ",
      country: "United States",
      countryCode: "US",
      region: "California",
      city: "Palo Alto",
      postalCode: "94301",
      street: "725 Alma Street",
      text: "725 Alma Street, Palo Alto, CA 94301",
      latitude: 37.44178713736534,
      longitude: -122.16064940120228
    }
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Offline Purchase Completed",
  "properties": {
    "$order": {
      "orderNumber": "34859456045",
      "revenue": 73.40,
      "discount": 10.00,
      "discountCode": "10OFF",
      "tax": 5.00,
      "shipping": 7.00,
      "currency": "USD",
      "salesperson": "Jane",
      "cashier": "John",
      "products": [
        {
          "id": "23489023",
          "sku": "23489023",
          "name": "Red Shoes",
          "categories": [
            "Shoes & Accessories > Shoes",
            "Shoes & Accessories > Shoes > Women Shoes"
          ],
          "price": 49.95,
          "quantity": 1,
          "url": "https://example.com/products/23489023",
          "imageUrl": "https://example.com/products/23489023.jpg",
          "currency": "USD",
          "variant": "Striped",
          "color": "Red",
          "size": "US 8",
          "brand": "Nike"
        }
      ],
      "location": {
        "id": "243850934",
        "name": "Fanplayr HQ",
        "country": "United States",
        "countryCode": "US",
        "region": "California",
        "city": "Palo Alto",
        "postalCode": "94301",
        "street": "725 Alma Street",
        "text": "725 Alma Street, Palo Alto, CA 94301",
        "latitude": 37.44178713736534,
        "longitude": -122.16064940120228
      }
    }
  }
}

Purchase Returned

Indicate a purchase was returned.

• $order - Order

Interface

Interface

interface PurchaseReturned {
  event: 'Purchase Returned'
  properties: {
    $order: Order
  }
}

JavaScript API

Example

fp360.track('Purchase Returned', {
  $order: {
    orderNumber: "34859456045",
    returnReference: "9764383",
    returnReason: "Change of mind",
    revenue: 73.40,
    tax: 5.00,
    currency: "USD",
    cashier: "John",
    products: [
      {
        id: "23489023",
        sku: "23489023",
        name: "Red Shoes",
        categories: [
          "Shoes & Accessories > Shoes",
          "Shoes & Accessories > Shoes > Women Shoes"
        ],
        price: 49.95,
        quantity: 1,
        url: "https://example.com/products/23489023",
        imageUrl: "https://example.com/products/23489023.jpg",
        currency: "USD",
        variant: "Striped",
        color: "Red",
        size: "US 8",
        brand: "Nike"
      }
    ],
    location: {
      id: "243850934",
      name: "Fanplayr HQ",
      country: "United States",
      countryCode: "US",
      region: "California",
      city: "Palo Alto",
      postalCode: "94301",
      street: "725 Alma Street",
      text: "725 Alma Street, Palo Alto, CA 94301",
      latitude: 37.44178713736534,
      longitude: -122.16064940120228
    }
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Purchase Returned",
  "properties": {
    "$order": {
      "orderNumber": "34859456045",
      "returnReference": "9764383",
      "returnReason": "Change of mind",
      "revenue": 73.40,
      "tax": 5.00,
      "currency": "USD",
      "cashier": "John",
      "products": [
        {
          "id": "23489023",
          "sku": "23489023",
          "name": "Red Shoes",
          "categories": [
            "Shoes & Accessories > Shoes",
            "Shoes & Accessories > Shoes > Women Shoes"
          ],
          "price": 49.95,
          "quantity": 1,
          "url": "https://example.com/products/23489023",
          "imageUrl": "https://example.com/products/23489023.jpg",
          "currency": "USD",
          "variant": "Striped",
          "color": "Red",
          "size": "US 8",
          "brand": "Nike"
        }
      ],
      "location": {
        "id": "243850934",
        "name": "Fanplayr HQ",
        "country": "United States",
        "countryCode": "US",
        "region": "California",
        "city": "Palo Alto",
        "postalCode": "94301",
        "street": "725 Alma Street",
        "text": "725 Alma Street, Palo Alto, CA 94301",
        "latitude": 37.44178713736534,
        "longitude": -122.16064940120228
      }
    }
  }
}

Widget Viewed

Indicate a widget was viewed. This can be used for online popups such as email collection, surveys or offers.

• $widget - Widget

• $targeting - Targeting

Interface

Interface

interface WidgetViewed {
  type: 'track'
  event: 'Widget Viewed'
  properties: {
    $widget: Widget
    $targeting?: Targeting
    $discountCode?: string
  }
}

JavaScript API

Example

fp360.track('Widget Viewed', {
  $widget: {
    id: "19811",
    name: "Present a great offer",
  },
  $targeting: {
    offerId: "12"
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Widget Viewed",
  "properties": {
    "$widget": {
      "id": "19811",
      "name": "Present a great offer"
    },
    "$targeting": {
      "offerId": "12"
    }
  }
}

Widget Interacted

Indicate an action was taken on a widget. This can be used for online popups such as email collection, surveys or offers.

• $widget - Widget

• $targeting - Targeting

Interface

Interface

interface WidgetInteracted { 
  type: 'track'
  event: 'Widget Interacted'
  properties: {
    $widget: Widget
    $targeting?: Targeting
    $discountCode?: string
  }
}

JavaScript API

Example

fp360.track('Widget Interacted', {
  $widget: {
    id: "19811",
    name: "Present a great offer",
    action: "afn",
  },
  $targeting: {
    offerId: "12"
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Widget Interacted",
  "properties": {
    "$widget": {
      "id": "19811",
      "name": "Present a great offer",
      "action": "afn",
    },
    "$targeting": {
      "offerId": "12"
    }
  }
}

Offer Viewed

Indicate an offer was presented. This can be used online in cases where a special offer was presented to a user.

• $widget - Widget

• $targeting - Targeting

Interface

Interface

interface OfferViewed {
  type: 'track'
  event: 'Offer Viewed'
  properties: {
    $widget: Widget
    $targeting: Targeting
    $discountCode?: string
  }
}

JavaScript API

Example

fp360.track('Offer Viewed', {
  $widget: {
    id: "19811",
    name: "Present a great offer",
  },
  $targeting: {
    offerId: "12"
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Offer Viewed",
  "properties": {
    "$widget": {
      "id": "19811",
      "name": "Present a great offer"
    },
    "$targeting": {
      "offerId": "12"
    }
  }
}

Recommendation Viewed

A recommendation was viewed.

• $recommendation - Recommendation

• $widget - Widget

• $targeting - Targeting

Interface

Interface

interface RecommendationViewed {
  event: 'Recommendation Viewed'
  properties: {
    $recommendation: Recommendation
    $widget?: Widget
    $targeting?: Targeting
  }
}

JavaScript API

Example

fp360.track('Recommendation Viewed', {
  $recommendation: {
    id: "7812087d-d7ff-46d7-a790-eb60c4bb679f",
    model: "Others You May Like",
    products: [
      {
        id: "23489023",
        sku: "23489023",
        name: "Red Shoes",
        categories: [
          "Shoes & Accessories > Shoes",
          "Shoes & Accessories > Shoes > Women Shoes"
        ],
        price: 49.95,
        quantity: 1,
        url: http://example.com/products/23489023",
        imageUrl: http://example.com/products/23489023.jpg",
        currency: "USD",
        variant: "Striped",
        color: "Red",
        size: "US 8",
        brand: "Nike"
      }
    ]
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Recommendation Viewed",
  "properties": {
    "$recommendation": {
      "id": "7812087d-d7ff-46d7-a790-eb60c4bb679f",
      "model": "Others You May Like",
      "products": [
        {
          "id": "23489023",
          "sku": "23489023",
          "name": "Red Shoes",
          "categories": [
            "Shoes & Accessories > Shoes",
            "Shoes & Accessories > Shoes > Women Shoes"
          ],
          "price": 49.95,
          "quantity": 1,
          "url": "https://example.com/products/23489023",
          "imageUrl": "https://example.com/products/23489023.jpg",
          "currency": "USD",
          "variant": "Striped",
          "color": "Red",
          "size": "US 8",
          "brand": "Nike"
        }
      ]
    }
  }
}

Recommendation Clicked

A recommendation was clicked.

• $recommendation - Recommendation

• $widget - Widget

• $targeting - Targeting

Interface

Interface

interface RecommendationClicked {
  event: 'Recommendation Clicked'
  properties: {
    $recommendation: Recommendation
    $widget?: Widget
    $targeting?: Targeting
  }
}

JavaScript API

Example

fp360.track('Recommendation Clicked', {
  $recommendation: {
    id: "7812087d-d7ff-46d7-a790-eb60c4bb679f",
    model: "Others You May Like",
    products: [
      {
        id: "23489023",
        sku: "23489023",
        name: "Red Shoes",
        categories: [
            "Shoes & Accessories > Shoes",
            "Shoes & Accessories > Shoes > Women Shoes"
          ],
        price: 49.95,
        quantity: 1,
        url:http://example.com/products/23489023",
        imageUrl:http://example.com/products/23489023.jpg",
        currency: "USD",
        variant: "Striped",
        color: "Red",
        size: "US 8",
        brand: "Nike"
      }
    ]
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Recommendation Clicked",
  "properties": {
    "$recommendation": {
      "id": "7812087d-d7ff-46d7-a790-eb60c4bb679f",
      "model": "Others You May Like",
      "products": [
        {
          "id": "23489023",
          "sku": "23489023",
          "name": "Red Shoes",
          "categories": [
            "Shoes & Accessories > Shoes",
            "Shoes & Accessories > Shoes > Women Shoes"
          ],
          "price": 49.95,
          "quantity": 1,
          "url": "https://example.com/products/23489023",
          "imageUrl": "https://example.com/products/23489023.jpg",
          "currency": "USD",
          "variant": "Striped",
          "color": "Red",
          "size": "US 8",
          "brand": "Nike"
        }
      ]
    }
  }
}

Recommendation Added

A recommendation was added.

• $recommendation - Recommendation

• $widget - Widget

• $targeting - Targeting

Interface

Interface

interface RecommendationAdded {
  event: 'Recommendation Added'
  properties: {
    $recommendation: Recommendation
    $widget?: Widget
    $targeting?: Targeting
  }
}

JavaScript API

Example

fp360.track('Recommendation Added', {
  $recommendation: {
    id: "7812087d-d7ff-46d7-a790-eb60c4bb679f",
    model: "Others You May Like",
    products: [
      {
        id: "23489023",
        sku: "23489023",
        name: "Red Shoes",
        categories: [
          "Shoes & Accessories > Shoes",
          "Shoes & Accessories > Shoes > Women Shoes"
        ],
        price: 49.95,
        quantity: 1,
        url: http://example.com/products/23489023",
        imageUrl: http://example.com/products/23489023.jpg",
        currency: "USD",
        variant: "Striped",
        color: "Red",
        size: "US 8",
        brand: "Nike"
      }
    ]
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Recommendation Added",
  "properties": {
    "$recommendation": {
      "id": "7812087d-d7ff-46d7-a790-eb60c4bb679f",
      "model": "Others You May Like",
      "products": [
        {
          "id": "23489023",
          "sku": "23489023",
          "name": "Red Shoes",
          "categories": [
            "Shoes & Accessories > Shoes",
            "Shoes & Accessories > Shoes > Women Shoes"
          ],
          "price": 49.95,
          "quantity": 1,
          "url": "https://example.com/products/23489023",
          "imageUrl": "https://example.com/products/23489023.jpg",
          "currency": "USD",
          "variant": "Striped",
          "color": "Red",
          "size": "US 8",
          "brand": "Nike"
        }
      ]
    }
  }
}

Recommendation Purchased

A recommendation was displayed to the user and then the user purchased one of these products.

• $recommendation - Recommendation

• $widget - Widget

• $targeting - Targeting

Interface

Interface

interface RecommendationPurchased {
  event: 'Recommendation Purchased'
  properties: {
    $recommendation: Recommendation
    $widget?: Widget
    $targeting?: Targeting
  }
}

JavaScript API

Example

fp360.track('Recommendation Purchased', {
  $recommendation: {
    id: "7812087d-d7ff-46d7-a790-eb60c4bb679f",
    model: "Others You May Like",
    products: [
      {
        id: "23489023",
        sku: "23489023",
        name: "Red Shoes",
        categories: [
          "Shoes & Accessories > Shoes",
          "Shoes & Accessories > Shoes > Women Shoes"
        ],
        price: 49.95,
        quantity: 1,
        url: http://example.com/products/23489023",
        imageUrl: http://example.com/products/23489023.jpg",
        currency: "USD",
        variant: "Striped",
        color: "Red",
        size: "US 8",
        brand: "Nike"
      }
    ]
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Recommendation Purchased",
  "properties": {
    "$recommendation": {
      "id": "7812087d-d7ff-46d7-a790-eb60c4bb679f",
      "model": "Others You May Like",
      "products": [
        {
          "id": "23489023",
          "sku": "23489023",
          "name": "Red Shoes",
          "categories": [
            "Shoes & Accessories > Shoes",
            "Shoes & Accessories > Shoes > Women Shoes"
          ],
          "price": 49.95,
          "quantity": 1,
          "url": "https://example.com/products/23489023",
          "imageUrl": "https://example.com/products/23489023.jpg",
          "currency": "USD",
          "variant": "Striped",
          "color": "Red",
          "size": "US 8",
          "brand": "Nike"
        }
      ]
    }
  }
}

Form Submitted

Indicates that a form was submitted.

$widget - Widget

Interface

Interface

interface FormSubmitted {
  event: 'Form Submitted'
  properties: {
    $widget?: Widget
  }
}

JavaScript API

Example

fp360.track('Form Submitted', {
  $widget: {
    id: "19811",
    name: "Present a great offer",
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Form Submitted",
  "properties": {
    "$widget": {
      "id": "19811",
      "name": "Present a great offer"
    }
  }
}

Form Interacted

Indicates that a form was interacted with.

$widget - Widget

Interface

Interface

interface FormInteracted {
  event: 'Form Interacted'
  properties: {
    $widget?: Widget
  }
}

JavaScript API

Example

fp360.track('Form Interacted', {
  $widget: {
    id: "19811",
    name: "Present a great offer",
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Form Interacted",
  "properties": {
    "$widget": {
      "id": "19811",
      "name": "Present a great offer"
    }
  }
}

Form Viewed

Indicates that a form was viewed.

$widget - Widget

Interface

Interface

interface FormViewed {
  event: 'Form Viewed'
  properties: {
    $widget?: Widget
  }
}

JavaScript API

Example

fp360.track('Form Viewed', {
  $widget: {
    id: "19811",
    name: "Present a great offer",
  }
})

Custom API

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Form Viewed",
  "properties": {
    "$widget": {
      "id": "19811",
      "name": "Present a great offer"
    }
  }
}