analytics

Documentation

Overview

Package analytics provides functions to send analytics to analytics stores such as Google Analytics.

Index

• func Add(b Backend)
• func GoogleAnalyticsHeader(propertyID string) string
• func Identify(userID string, traits map[string]interface{})
• func Page(name string, properties map[string]interface{})
• func Track(event string, properties map[string]interface{})
• type Backend
  • func NewGoogleAnalytics() Backend

Functions

func Add

func Add(b Backend)

Add adds the given backend to the backends used to send analytics.

func GoogleAnalyticsHeader

func GoogleAnalyticsHeader(propertyID string) string

GoogleAnalyticsHeader returns the header to use in the app.Handler.RawHeader field to initialize Google Analytics.

func Identify

func Identify(userID string, traits map[string]interface{})

Identify links your users, and their actions, to a recognizable userID and traits.

func Page

func Page(name string, properties map[string]interface{})

Page records page views on your website, along with optional extra information about the page viewed by the user.

The following properties are automatically set: path, referrer, search, title and url.

func Track

func Track(event string, properties map[string]interface{})

Track record actions your users perform.

Types

type Backend

type Backend interface {
	// Links your users, and their actions, to a recognizable userID and traits.
	Identify(userID string, traits map[string]interface{})

	// Record actions your users perform.
	Track(event string, properties map[string]interface{})

	// Records page views on your website, along with optional extra information
	// about the page viewed by the user.
	Page(name string, properties map[string]interface{})
}

Backend is the interface that describes an analytics backend that sends analytics for a defined provider.

func NewGoogleAnalytics

func NewGoogleAnalytics() Backend