Skip to content

Latest commit

 

History

History
53 lines (28 loc) · 3.23 KB

README.md

File metadata and controls

53 lines (28 loc) · 3.23 KB

Keen IO Auto-Collector Dashboard 📉📊📈

An instant analytics dashboard for Keen IO projects using the Auto-Collector.

This dashboard is built using the existing event data models, so you don't have to!

You can clone the project to make it your own in Glitch with your own Keen IO data here:

Remix on Glitch

Getting Started

To get started, you need:

If you don’t already have Auto-Collector installed, drop in this snippet with your PROJECT_ID and WRITE_KEY into your website’s <head> code and start seeing web events flow in within seconds.

Once you have these two things, you can clone (or "remix") the code in Glitch or locally by git cloning this repo.

(By the way, I used Glitch, a free-to-use, collaborative code editor and hosting system, because it’s amazing and you can have a working dashboard in seconds.)

Next, you need to replace the example projectId and readKey in the settings.js file with those for your project.

You can also choose what the relative timeframe your dashboard queries. We have set it at this_4_weeks in settings.js to start.

Running the Application

If you are running the project within Glitch, click the "Show Live" button.

If you are running the project locally and have the files downloaded or git cloned, open the index.html file in a browser.

Your dashboard should now render in your browser! 🎉📊✨

Going Forward

The cool thing about the Auto-Collector is that it is just a start.

Since you don’t have to think about what your data model is, it’s a great starting point to hit the ground running quickly. You can always customize and enrich your data and your data views later alongside the event data models from the Auto-Collector.

If you want to track custom events beyond pageviews, clicks, and form submissions, you can easily access our core Javascript tracking library (which this SDK uses under the hood). See more here.

For example: You could have a graph of signup or login events that are custom to your application. Other example actions you could track with Keen IO are: purchases, powerups, upgrades, errors, swipes, favorites, impressions, etc.

If you want to think more about event data, check out this blog post.

Contributions Welcome

This is an open source project, and we love involvement from the community! If you are interested in getting involved, please see the CONTRIBUTING.md file.

Need Help?

Send us an email at [email protected] or join our Community Slack to share bugs, issues, or suggestions!