Smartlook

Android

iOS

React Native

Flutter

Ionic

Cordova

Unity

Unreal Engine

Cocos

Xamarin

Web
SDK Installation
AndroidiOSCocosCordovaFlutterIonicReact NativeUnityUnreal Engine 4Xamarin
SDK Conceptual
SDK API reference
SDK Cookbooks
SDK Integrations
REST API (beta)

Ionic SDK Installation

  1. Install Smartlook Ionic native plugin:
npm install @ionic-native/smartlook --save
  1. Add Cordova plugin plugin to your project:
ionic cordova plugin add cordova-plugin-smartlook
  1. Inject Smartlook SDK into app.module.ts:
import { Smartlook } from '@ionic-native/smartlook/ngx';
...
@NgModule({
...
providers: [Smartlook, ...]
...
})
export class AppModule {}
  1. Import Smartlook and SmartlookSetupConfig into app.component.ts and setup the SDK in platform ready callback:
import { Smartlook, SmartlookSetupConfig } from '@ionic-native/smartlook/ngx';
...
@Component( ... )
export class AppComponent {
constructor(private smartlook: Smartlook) {
this.platform.ready().then(() => {
this.smartlook.setupAndStartRecording(new SmartlookSetupConfig("YOUR API KEY"));
}
}
}

To setup Smartlook, the unique project API key is needed. It can be found in the mobile project settings in Smartlook Dashboard.

  1. Smartlook now starts recording the app. The recordings will appear in the Smartlook player shortly.

SDK will upload sessions only on WiFi. When uploading on mobile connections is requested, it must be enabled in the project settings in the dashboard. More details about the recording process can be found in the Conceptual documentation.

Supported versions

Current minimal supported version is Jelly Bean (API 18) for Android and 10 for iOS.

Ionic framework 4.0 is needed to support Ionic native plugins such as this one. If you are using older versions of Ionic framework and want to use Smartlook SDK, you can use our Cordova SDK directly.

Further Steps

All Smartlook SDK methods are documented in the Smartlook API reference.

Some advanced use-case and troubleshooting case-studies are described in the Cookbooks section of this documentation.

Issues and bugs can be reported in the issue tracker.

Concepts undelying the Smartlook functionality are descibed in the Conceptual documentation: