PinchSDK

# Onboarding Metrics

This page describes how you can use PinchSDK to collect metrics about the onboarding process in your application.

Adding Onboarding Metrics to your application allows us to analyze your onboarding process and figure out which parts need improvement to get a higher onboarding rate.

# Notification

The following methods are used if:

  • User has to start the onboarding process
  • System does not force onboarding to occur

This can be a banner that remains until dismissed by the user.

When showing a user dismissible notification with actions, you should log that you've sent such a notification.

This method accepts an optional parameter to distinguish between different onboarding versions.

If the user dismisses the notification and doesn't start the onboarding:

# Started

The following method is used if:

  • User has navigated to a page where they can agree or disagree to enable Pinch
  • System has forced the user to a page where they can agree or disagree to enable Pinch
  • User is shown a page about the onboarding and forced to continue, with no option to agree or disagree

This method accepted an optional parameter to distinguish between different onboarding versions.

If the user was given the option to agree or disagree, you should call a soft request after the user answers with the type pinch.

# Requesting soft permission

The following method is used if:

  • Prior to requesting runtime permission, you have a page describing why the permission is required
  • User has the option to agree or disagree to permission, prior to actually requesting the permission

The following method should be called after the user agrees or disagrees on the soft request. It accepts two parameters, the first one being a RequestType and the second a Bool describing if the user granted or denied the request.

# RequestTypes

RequestType describes what type of permission was requested.

The following RequestTypes are available:

# Requesting runtime permission

It is preferred that the runtime permission is only requested after the user has agreed to it during the soft request.

The following method is used if:

  • A runtime permission has been requested

Once the user has granted or denied the permission, you should call the following method in the request delegate. It accepts two parameters, the first one being a RequestType, and the second a boolean describing if the user granted or denied the request.

# Cancelled

The following method is used if:

  • User is able to cancel the onboarding at any point
  • User has cancelled the onboarding

# Completed

The following method is used if:

  • User has completed the onboarding