# Events

You use the **kontrl.event** function whenever something happens that needs to be tracked.
We will save that for **1 month**.
And when you want to, you can **display the events on the dashboard**.

**Events are pushed to Kontrl every 10 minutes**

## Kontrl.event()

You throw events with **kontrl.event(..)**.

**Params:**

- **name** The name of the event. Max 20 characters. Events with the same name are grouped.
- **value** The value the event currently has. Can be a string or object.

<!-- - **valueType** [Optional] can be "overwrite" and "stack". "stack" by default. (See valueType section) -->

<!-- ## Value type

When an event is called, it gets saved as an object.

**Example:**

```js
{
  name: "route_visits",
  meta: {
    "/": 3,
    "/users": 5
  }
}
``` -->

<!-- This gets saved withing your application and **every 30 minutes** this gets pushed **to the database**.

That way, it becomes much cheaper to save these events and we only charge 1 event per meta type that gets pushed to the database.
The **above example** will charge **2 events** every 30 minutes **if anything has been thrown**.

### The stack type

**This is the default**

The stack type means that when an event gets thrown, it gets added to the group.

Say for example, we currently have

```js
// Internally
{
  "route_visits": {
    "/": 3,
    "/users": 5
  }
}

// And we throw another event
kontrl.event({
  name: "route_visits",
  value: "/"
});

// We now have
{
  "route_visits": {
    "/": 4, // This is now 4
    "/users": 5
  }
}
```

### The overwrite type

So by default, kontrl.event -->

<!-- ## String values

```js
const kontrl = require("kontrl");

kontrl.event({
  name: "route_visits",
  value: "/users" // or the current route
});
``` -->

## Examples

Track route visits

```js
const kontrl = require("kontrl");

kontrl.event({
  name: "route_visit",
  value: "/about"
});
```

Track your sales

```js
const kontrl = require("kontrl");

kontrl.event({
  name: "sale",
  value: {
    "digimon_the_movie": 1,
    "yugioh_pack": 3
  }
});
```