[UPDATED] SDK Console FAQ and Troubleshooting

The SDK console is a tool to test if you have implemented your SDK/S2S integration with Singular properly.

After you add a test device to the console (by providing its ID), the console shows you whether your app is sending the information that Singular needs in order to attribute installs, track events, etc.

For a detailed guide on using the SDK console to test your integration, see How to Test Your Singular SDK Integration.

 

Troubleshooting

Why are no events showing up in the Events Log?

If you have registered a test device and are following the guide to test your SDK integration, but no rows are showing up in the Events Log, double-check the following:

  • Make sure you opened the app on the test device (to see a user session).
  • Make sure you created some in-app events (if you want to test your events).
  • The SDK Console only shows events live (it does not look for historical events from the device).
  • Make sure the device is enabled in the Tracked Devices list (the eye icon is not disabled):

screenshot-app.singular.net-2020.02.14-19-23-49.png

  • Look for the COLLECTING REAL TIME DATA message above the Events Log. If the message is displayed, it means that Singular is currently checking for events from at least one device. If no events are appearing in the log, this may indicate that they are not being sent properly by the SDK in your app.

FAQ

How do I use the SDK Console to test my integration?

For a detailed guide on using the SDK console to test your integration, see How to Test Your Singular SDK Integration.

How do I register a mobile device in order to start testing?

To add a device to the console:

  • In the Singular platform, go to Settings > SDK Console.
  • Click Add Device.

  • Select the platform of the device you are adding, and then select the keyspace (i.e., the type of advertising ID), e.g. IDFA or Google Advertising ID.

  • Input the ID from your device and click Add.

    image11.png

    Notes:

    • For iOS devices, we recommend using the IDFV if you have access to it. You can use the IDFA, but then you won't be able to make the console "forget" your device's data (see step 5).
    • Your device's GAID or IDFA should be available in your device's Settings menu. Singular also offers a Device Assist application that you can install on your test devices to help you acquire the device IDs. Download our app for iOS or for Android.
    • See also: Types of Device IDs.

Important: Make sure the new device appears in Tracked Devices list

The device has to be in enabled mode (the eye icon on the left should not be disabled) for any events from the device to appear in the Events Log.

You can add a descriptive name for the device in the Device Name column to make sure you don't confuse it with other devices you may be tracking.

image12.png

How do I read the Events Log?

Tip: For a detailed guide on using the SDK console to test your integration, see How to Test Your Singular SDK Integration.

After you've registered a device, sent some events, and waited around 1 minute, the events start appearing in the event log in the SDK Console page.

image8.png

Click on a row to show the full details of the event as sent from the app.

image9.png

Click Clear Log to empty the Events Log when it gets too long.

Tip: If you don't click Clear Log, the log retains the last 500 events from each of the tracked devices.

How do I delete/remove a device from the console?

Deleting a Device

To delete a device from the Tracking List, hover over the Device ID and click Delete. This will clear all event logs from the screen, but Singular will still remember that the app on this device has been attributed to a certain source.

Forgetting a Device

To forget a device, hover over the Device ID and click Forget. This makes Singular delete internal data about the device's attribution. It is part of the process of resetting a test device in order to use it for further attribution testing (see the next section).

See also: How do I reset a device and clear its attribution information so I can use it to test install attribution again?

How do I reset a device and clear its attribution information so I can use it to test install attribution again?

If you want to re-test your SDK integration again with the same device, you have to remove all locally cached data from the device, in addition to clearing the device's attribution in the Singular platform.

Steps for Android Devices

  1. Close the app and confirm that it is not running (use Force Stop from the Settings menu if you have the option).
  2. Go to the Settings menu by tapping the wheel icon in your notification window or in the Apps menu.
  3. Go to Apps, select the app you are testing, long press on the app and select App Info.
  4. Select Storage and then select Clear Cache and Clear Data.
  5. In the Singular SDK Console, hover over the device row and click Forget to have our system forget this device attribution.

    image5.png

Tip: Google Play offers apps that perform this function for you (see example).

Steps for iOS Devices

  1. Close the app and then uninstall.
  2. Open the SDK Console and click Forget to have our system forget this device attribution.

    image5.png

Tip: Testing With Re-engagement Inactivity Windows

The inactivity window is a setting that determines how long the user has to be inactive before they are eligible for re-engagement attribution. If you are testing re-engagement attribution prior to launching campaigns, an inactivity window would make it harder for you. This is why test devices (devices that have been added to the SDK console and have the eye icon enabled) are exempted from the inactivity window.

Was this article helpful?