Icontem

Countly Web SDK: Track site accesses and errors the Countly API

Recommend this page to a friend!
  Info   View files Documentation   View files View files (19)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2017-09-21 (4 days ago) RSS 2.0 feedNot enough user ratingsTotal: 73 This week: 1All time: 451 This week: 6Up
Version License JavaScript version Categories
countly-web-sdk 1.0Custom (specified...1.0AJAX, Web services
Collaborate with this project Author

Countly Web SDK - github.com

Description

This package track site accesses and errors the Countly API.

It can track several types of statistics and events like user sessions, clicks, form submissions, and JavaScript errors.

The events are reported to the Countly server using AJAX requests that can be sent synchronously or asynchronously to avoid page loading delays.

Innovation Award
JavaScript Programming Innovation award winner
August 2015
Winner
Countly is a service that can track several types of user access statistics and action events the users perform on pages.

This package uses the Country API to record useful information for the developer about important events like clicks on the page, form submissions or even JavaScript errors.

Manuel Lemos
  Performance   Level  
Name: Arturs Sosins <contact>
Classes: 51 packages by
Country: Latvia Latvia
Age: 29
All time rank: 1
Week rank: 1 Equal
Innovation award
Innovation award
Nominee: 8x

Winner: 6x

Details

Countly Web SDK

Build Status npm version Bower version Inline docs

What's Countly?

Countly is an innovative, real-time, open source mobile & web analytics, rich push notifications and crash reporting platform powering more than 2500 web sites and 14000 mobile applications as of 2017 Q3. It collects data from mobile phones, tablets, Apple Watch and other internet-connected devices, and visualizes this information to analyze application usage and end-user behavior.

With the help of Javascript SDK, Countly is a web analytics platform with features on par with mobile SDKs. For more information about web analytics capabilities, see this link.

There are two parts of Countly: the server that collects and analyzes data, and an SDK (mobile, web or desktop) that sends this data. This repository includes Countly Community Edition (server side). For more information other versions (e.g Enterprise Edition), see comparison of different Countly editions

This repository includes the Countly Web SDK. For more information about this SDK, Countly SDK for Web integration guide at Countly Resources or Countly Web SDK Documentation

Implementing Countly SDK in your web pages

There are 3 ways to get Countly SDK.

1. Available with Countly server

Since Countly server 16.02, Countly Web SDK is available in your Countly server installation in countly/frontend/express/public/sdk/web/countly.min.js which should be available through URL as http://yourserver.com/sdk/web/countly.min.js

2. Installation using package managers

bower install countly-sdk-web

or

npm install countly-sdk-web

or

yarn add countly-sdk-web

3. Use a CDN (content delivery network)

Countly web SDK is available on CDNJS. Use either

https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/17.9.0/countly.min.js

or

https://cdn.jsdelivr.net/npm/countly-sdk-web@latest/lib/countly.min.js

How to use Countly Web SDK?

Link to the script and call helper methods based on what you want to track: sessions, views, clicks, custom events, user data, etc. More information is available at http://resources.count.ly/docs/countly-sdk-for-web

Using Countly web SDK in your web page

Countly Web SDK has JSDoc3 compatible comments and you can generate documentation by running npm run-script docs or access online version at http://countly.github.io/countly-sdk-web/

Other Github resources

Check Countly Community Edition source code here:

There are also other Countly SDK repositories below:

How can I help you with your efforts?

Glad you asked. We need ideas, feedbacks and constructive comments. All your suggestions will be taken care with upmost importance. We are on Twitter and Facebook if you would like to keep up with our fast progress!

If you like Countly, why not use one of our badges and give a link back to us, so others know about this wonderful platform?

Light badge Dark badge

Support

For a public community support page, visit http://community.count.ly.

NPM

  Files folder image Files  
File Role Description
Files folder imageexamples (6 files)
Files folder imagelib (2 files)
Files folder imagetest (3 files)
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file bower.json Data Auxiliary data
Accessible without login Plain text file generateDocs.sh Data Auxiliary data
Accessible without login Plain text file inch.json Data Auxiliary data
Accessible without login Plain text file jsdoc_conf.json Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file package.json Data npm support
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  examples  
File Role Description
  Accessible without login Plain text file example_async.html Doc. Documentation
  Accessible without login HTML file example_fb.html Data Auxiliary data
  Accessible without login HTML file example_formdata.html Data Auxiliary data
  Accessible without login Plain text file example_helpers.html Doc. Documentation
  Accessible without login HTML file example_opt_out.html Doc. Documentation
  Accessible without login Plain text file example_sync.html Doc. Documentation

  Files folder image Files  /  lib  
File Role Description
  Plain text file countly.js Class Class source
  Plain text file countly.min.js Class Class source

  Files folder image Files  /  test  
File Role Description
  Accessible without login Plain text file tests_async.js Test Unit test script
  Accessible without login Plain text file tests_helpers.js Test Unit test script
  Accessible without login Plain text file tests_sync.js Test Unit test script

 Version Control Unique User Downloads Download Rankings  
 100%
Total:73
This week:1
All time:451
This week:6Up