Auditing Tool for SDK/S2S Integrations: FAQ

Follow
Avatar
Dora Kishinevsky
Updated

The SDK audit is a report that tests your SDK and S2S integrations and outputs a list of all the issues that it finds.

Run the SDK audit report after you have integrated the Singular SDK or S2S in your app(s) and you want to make sure the integrations have been set up properly.

The SDK audit report runs on all your iOS, Android, and Amazon apps.

 

FAQ

How do I run an SDK audit?

To run the SDK audit report:

TC_auditbutton.png

  1. Go to Developer Tools > Testing Console.
  2. Click Run Audit in the top right corner. 
  3. Once the report finishes running, you'll be able to download it in CSV format.
How does the SDK audit work and what data does it run on?

The SDK audit looks at data received from your apps in the last 3 days. It checks whether the data looks as expected, e.g.:

  • Whether the app is reporting user sessions (this is the most basic functionality of an SDK/S2S integration and is what enables Singular to track attribution)
  • Whether the app is reporting in-app events and revenue
  • Whether revenue is reported using best practices
  • Whether deferred deep linking is enabled
How do I read the SDK audit report?

Screen_Shot_2021-11-11_at_18.28.27.png

The report is a list of issues that have been found in your SDK and S2S integrations.

Column Description
App Name The name of the app as configured in Singular.
App Bundle The app bundle as configured in Singular, e.g., com.example.appname.
Platform iOS, Android, or Amazon.
App Version The app version number, if any.
Validation Name The area of the integration in which an issue has been found, e.g., "Custom user ID" or "Revenue events".
Type

The severity of the issue:

  • Error: This issue prevents the integration from working and you have to fix it before you go live with the app. For example, Singular is not receiving user sessions from the app. Without user sessions, we can't perform attribution.
  • Warning: The integration can work without this but you should fix it if you want to follow best practices and get the most from the Singular attribution tracker. For example, your app is not sending a custom user ID. The custom user ID is an optional feature but highly recommended.
  • Info: This issue concerns optional functionality that you may have chosen not to implement in your integration. For example, deferred deep linking (DDL) is not enabled in your app. DDL may simply not be relevant to your marketing strategy.
Error Description More information about the issue and how you can fix it.
How do I fix the issues found in the SDK audit?

Look at the Error Description for information about each issue. If needed, reread the relevant section in the SDK guide.

For warning/info type issues, make sure to check the Validation Name and see whether this is an optional SDK feature that you have chosen not to implement, such as deferred deep linking (DDL).  If so, you can ignore the error message.