eggcrate/

directory
v0.0.0-...-1aaf8f9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 24, 2018 License: MIT

README

eggcrate

It brings you the delicious statistic eggs from the henhouse.

usage

Add this directory to your GOPATH:

export GOPATH=$GOPATH:`pwd`

Copy the contents of .env.sample into another file with the correct url and port of the henhouse service, and source this new file. Run the server:

$ go run src/server.go
productFunnel

Use GET /api/v1/stats/productFunnel/:id to get a representation of the conversion funnel for product with id :id. This will eventually be able to filter down this representation based on different contexts for the purpose of examining changes in the funnel.

single product sums

Use GET /api/v1/stats/productSum/<step>/:id to get the count of a single event. Current choices for <step> are

  • list
  • pdp
  • cart
  • checkout
productStats

Use GET /api/v1/stats/productStats/:channel/:id to get product statistics for specified product and average for all products. additional params:

  • from - start of time range (unix time)
  • to - end of time range (unix time)
  • frequency - if specified then multiple values are returned corresponding to frequency size (minute, hour, day, week, month, quarter, year)
date ranges

To restrict the date range use query params to and from with dates in unix time format.

GET /api/v1/stats/productFunnel/1?from=1484315402&to=1484315462

Directory Description
src All source for eggcrate

Directories

Path Synopsis
src

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL