{"__v":23,"_id":"54367fe7d0ffee0e00f18ebf","category":{"__v":6,"_id":"54367defd0ffee0e00f18eb7","project":"541c6d8251a68c3b45b9ada7","version":"541c6d8251a68c3b45b9adaa","pages":["54367fe7d0ffee0e00f18ebf","54367eabd0ffee0e00f18eba","54367e73b7cf0e1c0020d8f7","54367f30d0ffee0e00f18ebc","543681dfb7cf0e1c0020d90d","54f8035bdc0d020d008b90e0","5549b55392fbb02500bc41cf"],"reference":false,"createdAt":"2014-10-09T12:22:07.198Z","from_sync":false,"order":6,"slug":"installation","title":"Installation"},"is_link":false,"project":"541c6d8251a68c3b45b9ada7","user":"541c6d3151a68c3b45b9ada6","version":{"__v":14,"_id":"541c6d8251a68c3b45b9adaa","project":"541c6d8251a68c3b45b9ada7","createdAt":"2014-09-19T17:53:06.500Z","releaseDate":"2014-09-19T17:53:06.500Z","categories":["541c6d8251a68c3b45b9adab","541c6e1c51a68c3b45b9adae","542baa54e5bb3e2000801fec","5436794bb7cf0e1c0020d8cc","54367d76b7cf0e1c0020d8e9","54367dc7b7cf0e1c0020d8f4","54367defd0ffee0e00f18eb7","54368035b7cf0e1c0020d8fe","5436ad91b7cf0e1c0020da6c","5447a252a1024f14005a6dd7","547e0c858466c808005369a1","54f6b81852174719008f610b","5516d13c16a294230084a985","557971d4fdbdb717002fa6c1"],"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"createdAt":"2014-10-09T12:30:31.891Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"results":{"codes":[]},"settings":"","try":true,"auth":"never","params":[],"url":""},"order":0,"body":"Countly has several SDKs to choose from. Some of them are supported by Countly, and others are contributed by community.\n\nBelow you can see a list of mobile and desktop SDKs.\n\n#### Officially Supported SDKs \n\n* [Android SDK on Github](https://github.com/Countly/countly-sdk-android) and corresponding [documentation page](doc:countly-sdk-for-android)\n* [iOS, Mac OS X and Apple Watch SDK on Github](https://github.com/Countly/countly-sdk-ios) and corresponding [documentation page](doc:countly-sdk-for-ios-and-os-x)\n* [Phonegap and Cordova](https://github.com/Countly/countly-sdk-js)\n* [Countly Web SDK](https://github.com/countly/countly-sdk-web) to track mobile HTML sites\n\n#### Community Supported SDKs\n\nThese client libraries are developed and supported by Countly community. Refer to the corresponding author for support and more information.\n\n* [Titanium Appcelerator SDK (iOS)](https://github.com/dieskim/countly-sdk-titanium-ios)\n* [Titanium Appcelerator SDK (Android)](https://github.com/dieskim/countly-sdk-titanium-android)\n* [Windows Phone 8 SDK on Github](https://github.com/Countly/countly-sdk-windows-phone) and corresponding [documentation page](doc:countly-sdk-for-windows-phone) \n* [Meteorjs SDK](https://atmospherejs.com/countly/countly-sdk-js)\n* [Unity SDK](https://github.com/imkira/unity-countly)\n* [Cocos2d-x SDK](https://github.com/shadow0162/countly-sdk-cocos2d-x)\n* [Mac OSX SDK](https://github.com/mrballoon/countly-sdk-osx)\n* [iOS and Mac OS X SDK](https://github.com/benoitsan/countly-sdk-cocoa) with many add-on features\n* [Corona SDK](https://github.com/brandontreb/Countly-Corona)\n* [Blackberry Webworks SDK](https://github.com/Countly/countly-sdk-blackberry-webworks) and install guide (not maintained)\n* [Blackberry Cascades SDK](https://github.com/craigmj/countly-sdk-blackberry10-cascades) (not maintained)\n* [Actionscript 3 SDK](https://github.com/Countly/countly-sdk-as3) (not maintained)\n\n#### Feature comparison\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"SDK\",\n    \"h-1\": \"Analytics\",\n    \"h-2\": \"Push notifications\",\n    \"h-3\": \"User Profiles\",\n    \"0-0\": \"Android\",\n    \"1-0\": \"iOS & Mac OS X\",\n    \"2-0\": \"Phonegap / Cordova\",\n    \"3-0\": \"Web SDK\",\n    \"4-0\": \"Titanium Appcelerator\",\n    \"0-1\": \"YES\",\n    \"1-1\": \"YES\",\n    \"2-1\": \"YES\",\n    \"3-1\": \"YES\",\n    \"4-1\": \"YES\",\n    \"0-2\": \"YES\",\n    \"1-2\": \"YES\",\n    \"2-2\": \"YES\",\n    \"3-2\": \"N/A\",\n    \"4-2\": \"YES\",\n    \"0-3\": \"YES\",\n    \"1-3\": \"YES\",\n    \"2-3\": \"YES\",\n    \"3-3\": \"YES\",\n    \"4-3\": \"YES\",\n    \"5-0\": \"Windows Phone\",\n    \"5-1\": \"YES\",\n    \"5-2\": \"NO\",\n    \"5-3\": \"YES\",\n    \"6-0\": \"ActionScript 3\",\n    \"6-1\": \"YES\",\n    \"6-2\": \"NO\",\n    \"6-3\": \"NO\",\n    \"7-0\": \"Corona\",\n    \"8-0\": \"Blackberry\",\n    \"8-1\": \"YES\",\n    \"7-1\": \"YES\",\n    \"7-2\": \"NO\",\n    \"8-2\": \"NO\",\n    \"7-3\": \"NO\",\n    \"8-3\": \"NO\"\n  },\n  \"cols\": 4,\n  \"rows\": 9\n}\n[/block]\n### Example iOS application for testing\n\nThere's an example iOS application that can be used to send data to Countly servers. Below you can see the instructions on how to use the example iOS application.\n\n  * Clone this repo:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://github.com/erkanyildiz/countly-sdk-samples\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n  * In countly-sdk-samples directory run this command to get latest iOS SDK:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"git submodule update --init --remote --merge\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n  * Open CountlyTestApp.xcodeproj in ios directory and add your app key and host in AppDelegate.m on this line:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[Countly.sharedInstance start:@\\\"YOUR_APP_KEY\\\" withHost:@\\\"https://YOUR_API_HOST.com\\\"];\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n  * Run project and you can see the session data immediately on your Dashboard. \n\n  * You can record custom events using one of the buttons on the screen. Custom events will be sent to server within 60 seconds, then you can see them in Events section. You can edit event keys and other values in ViewController.m if you want.\n\n### Example Android application for testing\n\n  * Download / clone SDK git repository https://github.com/Countly/countly-sdk-android\n  * Open downloaded project in Android Studio.\n  * Edit MainActivity.java in either app, or app-messaging module, specifying correct server / credentials / preferences: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://www.dropbox.com/s/606cu135i0at0ew/Screenshot%202015-0412%2015.20.11.png?dl=0 \",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n  * Select correct target: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://www.dropbox.com/s/lllubt9dah8uyey/Screenshot%202015-04-12%2015.18.47.png?dl=0\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n  * Hit Run.","excerpt":"","slug":"downloading-sdks","type":"basic","title":"Downloading & installing SDKs"}

Downloading & installing SDKs


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. #### Officially Supported SDKs * [Android SDK on Github](https://github.com/Countly/countly-sdk-android) and corresponding [documentation page](doc:countly-sdk-for-android) * [iOS, Mac OS X and Apple Watch SDK on Github](https://github.com/Countly/countly-sdk-ios) and corresponding [documentation page](doc:countly-sdk-for-ios-and-os-x) * [Phonegap and Cordova](https://github.com/Countly/countly-sdk-js) * [Countly Web SDK](https://github.com/countly/countly-sdk-web) to track mobile HTML sites #### Community Supported SDKs These client libraries are developed and supported by Countly community. Refer to the corresponding author for support and more information. * [Titanium Appcelerator SDK (iOS)](https://github.com/dieskim/countly-sdk-titanium-ios) * [Titanium Appcelerator SDK (Android)](https://github.com/dieskim/countly-sdk-titanium-android) * [Windows Phone 8 SDK on Github](https://github.com/Countly/countly-sdk-windows-phone) and corresponding [documentation page](doc:countly-sdk-for-windows-phone) * [Meteorjs SDK](https://atmospherejs.com/countly/countly-sdk-js) * [Unity SDK](https://github.com/imkira/unity-countly) * [Cocos2d-x SDK](https://github.com/shadow0162/countly-sdk-cocos2d-x) * [Mac OSX SDK](https://github.com/mrballoon/countly-sdk-osx) * [iOS and Mac OS X SDK](https://github.com/benoitsan/countly-sdk-cocoa) with many add-on features * [Corona SDK](https://github.com/brandontreb/Countly-Corona) * [Blackberry Webworks SDK](https://github.com/Countly/countly-sdk-blackberry-webworks) and install guide (not maintained) * [Blackberry Cascades SDK](https://github.com/craigmj/countly-sdk-blackberry10-cascades) (not maintained) * [Actionscript 3 SDK](https://github.com/Countly/countly-sdk-as3) (not maintained) #### Feature comparison [block:parameters] { "data": { "h-0": "SDK", "h-1": "Analytics", "h-2": "Push notifications", "h-3": "User Profiles", "0-0": "Android", "1-0": "iOS & Mac OS X", "2-0": "Phonegap / Cordova", "3-0": "Web SDK", "4-0": "Titanium Appcelerator", "0-1": "YES", "1-1": "YES", "2-1": "YES", "3-1": "YES", "4-1": "YES", "0-2": "YES", "1-2": "YES", "2-2": "YES", "3-2": "N/A", "4-2": "YES", "0-3": "YES", "1-3": "YES", "2-3": "YES", "3-3": "YES", "4-3": "YES", "5-0": "Windows Phone", "5-1": "YES", "5-2": "NO", "5-3": "YES", "6-0": "ActionScript 3", "6-1": "YES", "6-2": "NO", "6-3": "NO", "7-0": "Corona", "8-0": "Blackberry", "8-1": "YES", "7-1": "YES", "7-2": "NO", "8-2": "NO", "7-3": "NO", "8-3": "NO" }, "cols": 4, "rows": 9 } [/block] ### Example iOS application for testing There's an example iOS application that can be used to send data to Countly servers. Below you can see the instructions on how to use the example iOS application. * Clone this repo: [block:code] { "codes": [ { "code": "https://github.com/erkanyildiz/countly-sdk-samples", "language": "text" } ] } [/block] * In countly-sdk-samples directory run this command to get latest iOS SDK: [block:code] { "codes": [ { "code": "git submodule update --init --remote --merge", "language": "text" } ] } [/block] * Open CountlyTestApp.xcodeproj in ios directory and add your app key and host in AppDelegate.m on this line: [block:code] { "codes": [ { "code": "[Countly.sharedInstance start:@\"YOUR_APP_KEY\" withHost:@\"https://YOUR_API_HOST.com\"];", "language": "text" } ] } [/block] * 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, then 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 * Download / clone SDK git repository https://github.com/Countly/countly-sdk-android * Open downloaded project in Android Studio. * Edit MainActivity.java in either app, or app-messaging module, specifying correct server / credentials / preferences: [block:code] { "codes": [ { "code": "https://www.dropbox.com/s/606cu135i0at0ew/Screenshot%202015-0412%2015.20.11.png?dl=0 ", "language": "text" } ] } [/block] * Select correct target: [block:code] { "codes": [ { "code": "https://www.dropbox.com/s/lllubt9dah8uyey/Screenshot%202015-04-12%2015.18.47.png?dl=0", "language": "text" } ] } [/block] * Hit Run.