api

Documentation

Index

• Variables
• func Events(w http.ResponseWriter, r *http.Request)
• func Health(w http.ResponseWriter, r *http.Request)
• func Version(w http.ResponseWriter, r *http.Request)
• type Request
  • func (r *Request) Parse(body io.Reader) error

Variables

var ErrBadJSON = errors.New("api: invalid json ")

Functions

func Events

func Events(w http.ResponseWriter, r *http.Request)

Events accepts events payloads from vince client script.

func Health

func Health(w http.ResponseWriter, r *http.Request)

func Version

func Version(w http.ResponseWriter, r *http.Request)

Types

type Request

type Request struct {
	EventName   string `json:"n"`
	URI         string `json:"url"`
	Referrer    string `json:"r"`
	Domain      string `json:"d"`
	ScreenWidth int    `json:"w"`
	HashMode    bool   `json:"h"`
}

Request is sent by the vince script embedded in client websites. For faster performance we use simd if available

func (*Request) Parse

func (r *Request) Parse(body io.Reader) error

Parse opportunistic parses request body to r object. This is crucial method any gains here translates to smooth events ingestion pipeline.

A hard size limitation of 32kb is imposed. This is arbitrary value, any change to it must be be supported with statistics.