Icontem

File: README.md

Recommend this page to a friend!
  Classes of Arturs Sosins  >  Countly Web SDK  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Countly Web SDK
Track site accesses and errors the Countly API
Author: By
Last change: Update README.md
Date: 2 months ago
Size: 6,201 bytes
 

Contents

Class file image Download

Countly Web SDK

Build Status Codacy Badge npm version Inline docs ![](https://www.jsdelivr.com/package/npm/countly-sdk-web)

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/19.8.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/

Security

Security is very important to us. If you discover any issue regarding security, please disclose the information responsibly by sending an email to security@count.ly and not by creating a GitHub issue.

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!

Badges

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?

<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg" alt="Countly - Product Analytics" /></a>

<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg" alt="Countly - Product Analytics" /></a>

<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg" alt="Countly - Product Analytics" /></a>

<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg" alt="Countly - Product Analytics" /></a>

Support

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

NPM