Start Guide

1. Login to the SmartBeat console

After your SmartBeat account is created, you will receive an e-mail from SmartBeat Office with your ID and password.

You can login to the SmartBeat console from here.

- After successfully logging in, you can change your password by clicking your user-name on the upper right-hand side of the screen and selecting “Change password” from the menu.

- Supported browsers: Google Chrome, Firefox, and Safari

 

2. Add your application(s)

You can add your application(s) by clicking “Add App” on upper left-hand side of the screen (on the right-hand side of the SmartBeat logo) and filling in the necessary information.

- Please note that the time zone can not be changed later.

You will use the API Key displayed here in next step - “3. Integrate the SmartBeat SDK”.

3. Integrate the SmartBeat SDK

Download the appropriate SmartBeat SDK and integrate it to your application.

 

4. Console functions

When you successfully integrated the SDK your application’s errors will be collected and displayed on the SmartBeat console.

  • - Your applications are displayed side by side.
  • - On the upper right-hand side of the screen, the following menus are displayed:
    • - “Account settings”: Check and/or change your account settings.
    • - “Language settings”: Select the display language.
    • - “FAQ”: Link to the FAQ.
    • - “Manual”: Link to the Integration Manual.

 

4.1 Errors

By selecting an application from the list on the top page, you can check your application’s errors.

  • - On the top of the page a graph of error occurrence is displayed.
  • - Occurrences of the same error are grouped together and shown as one error on the list.
  • - From the left-hand column menu you can change the period and filter/reorder the errors.

 

4.2 Error detail

By clicking on an error in the error list you can view additional information for that group of errors.

  • - You can check on basic information for the error group such as the total number of occurrences and affected users, occurrence time and location, etc.
  • - Also, you can view a stack trace, device information, log, and screenshot by each error occurrence.
  • - On the right-hand column of the screen statistics information for this error group is displayed.

 

4.3 Analytics

On the “Analytics” screen you can view a quality evaluation score and check statistics information for each application.

  • - SmartBeat automatically calculates a quality evaluation score called “SB Score” and lists errors crucial to the perceived quality of your app.
  • - You can view statistics information such as Unique Users, Sessions, and share of Application Version/OS Version/Device.

 

4.4 Audience

This screen provides details about the age and gender distribution of your users.

audience_screenshot_20160418

The audience function needs over 1,000 unique identifiers(ie., advertising id for Android and idfa for iOS) to properly analyze your data. Please refer to the SmartBeat SDK Integration Manual, Audience Function.This feature is currently only applicable to end-users located within Japan. It may not be possible to display results if there is insufficient data. It doesn't work in Web SDK.

Activate audience

4.5 Settings

On the “Settings” screen you can check and/or change the settings of your application.

  • - “General Settings”: Change the name of the application, e-mail/Slack/Webhook notification preferences, and the status of application.
  • - “Viewer(s)”: Manage viewing permissions of your team members.
  • - “Transfer Ownership”: Change the owner of the app.
  • - “Upload mapping.txt to ReTrace (Android)/.so files for symbolication (Android)/dSYM to Symbolicate (iOS)”: Manage symbol mapping files for your app.
  • - “Remote Control Settings”: Control error collection and screenshot features.
4.5.1 Notification Condition Settings

Notifications from SmartBeat can be set using the controls found under General Settings.

The "Notification Condition" and "Notification Type Filter" settings apply to all Mail, Slack and Webhook notifications.

  • - The notificiation condition sets how many of the same error must be received before a notification is sent. Initially, this is set to only once.
  • - The notification type filter allows you to control which error types notifications will be sent for. Initially, all error types are enabled.

To enable mail notifications, switch the Mail setting to ON.
Usage instructions for Slack and Webhook notifications can be found in their respective sections later on this page.

4.5.2 Slack notification setting

To receive Slack notifications, please enter your Slack Webhook URL. After entering the URL and either pressing enter, or unfocusing the input box, an initialization test message will be sent to Slack. If the initialization test message is sent successfully, a checkmark will be displayed to the right of the input box. If you click the “Test” button, a test message with the same format as a real notification will be sent.

Ex) After enabling Slack notifications the following confirmation message will be posted:

slack_welcome

Ex) Message posted to Slack:

slack_notification

4.5.3 Webhook notification setting

To receive Webhook notifications, please enter your server’s Webhook URL. After entering the URL and either pressing enter, or unfocusing the input box, an initialization test message will be sent to the Webhook URL. If the initialization test message is sent successfully, a checkmark will be displayed to the right of the input box. If you click the “Send Test” button, a test message with the same format as a real notification will be sent.

Details of the SmartBeat Webhook API may be found here.


 

4.6 Account settings

4.6.1 Usage History

On the “Usage History” screen you can check your contract information and MAU (Monthly Active Users) of each team(s) and application(s).

 

4.6.2 Team members

On the “Team member” screen you can check/add/delete your team member(s). Only Administrators can use this function.

  • - In case you add someone who already has a SmartBeat account they will receive an e-mail message asking them to login and check the team they belong to.
  • - In case you add someone who doesn’t already have a SmartBeat account they will receive an e-mail message asking them to sign up for a SmartBeat account.

 

5. Demo videos

Here are some demo videos that explain the SDK integration process for an Android application.

6. Other

Here are the FAQ and Inquiry form locations.