Collecting data with Trackers and Webhooks

  1. Home
  2. Docs
  3. Collecting data with Trackers and Webhooks
  4. Trackers – collecting data from your own applications
  5. Scala Tracker
  6. Sending events

Sending events

Additional type safety

Since 0.5.0 self-describing events and contexts can be sent with SchemaKey wrapper from Iglu Core for additional type-safety.

val pageTypeContext = SelfDescribingJson( SchemaKey("com.acme", "page_type", "jsonschema", SchemaVer(1,0,0)), ("type" -> "promotional") ~ ("backgroundColor" -> "red") ) t.trackPageView(url, contexts = List(pageTypeContext))

## trackSelfDescribingEvent

Use trackSelfDescribingEvent to track a custom Self-describing events (previously known as Unstructured Events) which consists of a name and an unstructured set of properties. This is useful when:

  • You want to track event types which are proprietary/specific to your business (i.e. not already part of Snowplow), or
  • You want to track events which have unpredictable or frequently changing properties

You can use its alias trackUnstructEvent.

ArgumentDescriptionRequired?Type
unstructuredEventSelf-describing JSON containing unstructured eventYesSelfDescribingJson
contextsList of custom contexts for the eventNoList[SelfDescribingJson]
timestampDevice created timestamp or true timestampNoOption[Timestamp]

Create a Snowplow unstructured event self-describing JSON using the json4s DSL:

import org.json4s.JsonDSL._ val productViewEvent = SelfDescribingJson( "iglu:com.acme/product_view/jsonschema/1-0-0", ("userType" -> "tester") ~ ("sku" -> "0000013") )

Send it using the trackSelfDescribingEvent tracker method:

tracker.trackSelfDescribingEvent(productViewEvent)

You can attach any number of custom contexts to an event:

val pageTypeContext = SelfDescribingJson( "iglu:com.acme/page_type/jsonschema/1-0-0", ("type" -> "promotional") ~ ("backgroundColor" -> "red") ) val userContext = SelfDescribingJson( "iglu:com.acme/user/jsonschema/1-0-0", ("userType" -> "tester") ) t.trackSelfDescribingEvent(productViewEvent, List(pageTypeContext, userContext))

trackStructEvent

Use trackStructEvent to track a custom event happening in your app which fits the Google Analytics-style structure of having up to five fields (with only the first two required).

ArgumentDescriptionRequired?Type
categoryThe grouping of structured events which this action belongs toYesString
actionDefines the type of user interaction which this event involvesYesString
labelA string to provide additional dimensions to the event dataNoOption[String]
propertyA string describing the object or the action performed on itNoOption[String]
valueA value to provide numerical data about the eventNoOption[Double]
contextsList of custom contexts for the eventNoList[SelfDescribingJson]
timestampDevice created timestamp or true timestampNoOption[Timestamp]

Example:

val pageTypeContext = SelfDescribingJson( "iglu:com.acme/page_type/jsonschema/1-0-0", ("type" -> "promotional") ~ ("backgroundColor" -> "red") ) val userContext = SelfDescribingJson( "iglu:com.acme/user/jsonschema/1-0-0", ("userType" -> "tester") ) t.trackStructEvent("commerce", "order", property=Some("book"), contexts=List(pageTypeContext, userContext))

trackPageView

Use trackPageView to track a user viewing a page within your app. Arguments are:

ArgumentDescriptionRequired?Validation
pageUrlThe URL of the pageYesString
pageTitleThe title of the pageNoOption[String]
referrerThe address which linked to the pageNoOption[String]
contextsCustom contexts for the eventNoList[SelfDescribingJson]
timestampWhen the pageview occurredNoOption[Timestamp]

Example:

t.trackPageView("www.example.com", Some("example"), Some("www.referrer.com"))

trackError

Use trackError to track exceptions raised during your app’s execution. Arguments are:

ArgumentDescriptionRequired?Validation
errorAny throwable need to be trackedYesThrowable
contextsCustom contexts for the eventNoList[SelfDescribingJson]
timestampWhen the pageview occurredNoOption[Timestamp]

Example:

try { 1 / 0 } catch { case e: java.lang.ArithmeticException => t.trackError(e) }

Note: this tracker should not be used to track exceptions happening in tracker itself, use callbacks mechanism for that.

trackAddToCart

Use trackAddToCart to track an add-to-cart event.

trackRemoveFromCart

Use trackRemoveFromCart to track a remove-from-cart event.

trackTransaction

Use trackTransaction to record view of transaction. Fire a trackTransaction to register the transaction, and then fire trackTransactionItem to log specific data about the items that were part of that transaction.

trackTransactionItem

To track an ecommerce transaction item. Fire a trackTransaction to register the transaction, and then fire trackTransactionItem to log specific data about the items that were part of that transaction.

Setting timestamp

By default, Scala Tracker will generate a dvce_created_tstamp and add it to event payload. You also can manually set it using timestamp argument in all tracking methods. It should be in milliseconds since the Unix epoch:

tracker.trackSelfDescribingEvent(productViewEvent, Nil, Some(1432806619000L))

Beside of it, you can set true_tstamp if you have more reliable source about event timestamp. You can tag timstamp as “true” using class TrueTimestamp:

tracker.trackSelfDescribingEvent(productViewEvent, Nil, Some(Tracker.TrueTimestamp(1432806619000L)))

Now event will be sent with ttm parameter instead of dtm.