Countly Documentation

Countly Resources

Here you'll find comprehensive guides to help you start working with Countly as quickly as possible.

Downloading & installing SDKs

This is a list of our SDKs, together with download addresses and integration guides.

Countly has several SDKs to choose from. Some of them are supported by Countly, and others are contributed by community.

Below you can see a list of mobile and desktop SDKs.

Subscribe to SDK Github repositories

In order to get notified about SDK changes, you should be subscribed to corresponding SDK repositories on Github. This will help you get notified when there is a new release.

Officially Supported SDKs

This table includes a list of all officially supported SDKs, maintained by Countly.

SDK name
Download link
Documentation link

iOS, watchOS, tvOS & OSX SDK (for Objective-C and Swift apps)

Web SDK (Javascript) - to track web sites

NodeJS SDK (Javascript) - to track Node.js running apps and devices

Phonegap, Icenium, Cordova, Meteorjs, Ionic SDK

Windows Phone & Windows SDK

Also, Xamarin is supported in the way that it provides necessary bindings for iOS and Android. This eliminates the need for a Xamarin SDK specifically built for Countly and iOS & Android SDKs can be used instead. Here is a short tutorial to bind Countly SDK to Xamarin apps. Windows SDK also has PCL support to be used in Xamarin.iOS and Xamarin.Android applications. For more information, please check related Xamarin documentation.

Countly Code Generator

If you want to generate mobile or web code easily for custom events, user profiles, crash reporting and all other features that comes with Countly in general, we suggest that you use Countly Code Generator, which is a point and click service that builds necessary code for you.

Community Supported SDKs

These client libraries are developed and supported by Countly community. Refer to the corresponding author for support and more information.

Feature comparison

This is a feature comparison for officially supported SDKs.

SDK
Analytics
Push notifications
User Profiles
Crash reports

Android

YES

YES

YES

YES

iOS & Mac OS X

YES

YES

YES

YES

Phonegap / Cordova

YES

YES

YES

NO

Web

YES

N/A

YES

YES

NodeJS

YES

N/A

YES

YES

React Native

YES

NO

YES

NO

Windows Phone

YES

NO

YES

YES

Example iOS application for testing

We have built a sample iOS application that can be used to send different types of data (e.g custom events, sessions, crash, user profiles etc) to Countly servers. Below you can see the instructions on how to use the example iOS application.

  • Clone this repo:
https://github.com/erkanyildiz/countly-sdk-samples
  • In countly-sdk-samples directory run this command to get latest iOS SDK:
git submodule update --init --remote --merge
  • Open CountlyTestApp.xcodeproj in iOS directory and add your app key and server hostname in AppDelegate.m on this line:
[Countly.sharedInstance start:@"YOUR_APP_KEY" withHost:@"https://YOUR_SERVER.com"];
  • Run project and you can see the session data immediately on your dashboard.

  • You can record custom events using one of the buttons on the screen. Custom events will be sent to server within 60 seconds, and after this you can see them in Events section. You can edit event keys and other values in ViewController.m if you want.

Example Android application for testing

Similar to iOS, we have a sample Android application that can send custom events, sessions, crash, user profiles etc to Countly servers. Below you can see the instructions on how to use the example Android application.

  • Download / clone Android SDK git repository
  • Open downloaded project in Android Studio.
  • Edit MainActivity.java in either app, or app-messaging module, specifying correct server / credentials / preferences.
  • Select correct target:
  • Hit Run.

Downloading & installing SDKs

This is a list of our SDKs, together with download addresses and integration guides.