KetchupJS

Our target is to make it easier for both large and small business owners to record analytical data. We created a library to use in your app to do that. Just use our library you want to record a piece of data in your code base, and view your analytics at ketchupjs.dev.

Quick Start

First, signup at ketchupjs.dev you will recieve a secret api key in order to use our service. DO NOT share this with anyone else.

After signing up and getting your api key run $ npm install ketchupjs.

Using KetchupJS

const ketchup = require('ketchupjs')

ketchup.config("api_key")

ketchup.save( metric, value, [user_name, [public]])

ketchup.most( metric, value, [user_name, [public]])

Parameters

| Name | Type | Description | |------|-------| :----------:| |api key |String| Key provided when account is created | | metric | String | Name of what you want to be recorded (Required) | | value | Number | Amount of metric to be recorded (Required)| | user_name | String | [Optional] Attaches metric and value to certain user| | public | String | [Requires user_name[Optional]] Makes data either public or private, defaults to setting on profile.|

Examples

config sets api key to allows access to use our service.

ketchup.config("XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX")

save records an event of the metric and its value.

ketchup.save("sales", 2.49)

You can assign the recorded event to a certain user by specifying their user_name.

ketchup.save("sales", 2.49, "User1")

By setting public to false you can prevent anyone from viewing this data through our service at ketchupjs.dev (defaulted to true, this can be changed in your profile settings).

ketchup.save("sales", 2.49, "User1", false)

most records the highest value and overwrites any previous lesser recorded value for the specified metric.

ketchup.most("daily_spending", 4.92, "User1", false)

Ex. if the value of daily_spending was greater than the valueStored, the event would be recorded, but if it were less than the valueStored it would not be recorded:

if(value > valueStored) {
  valueStored = value
};

This library does not work for browser based applications, Go to ketchupjs to learn more about using our Content delivery network(CDN).