Match Transparency API (Advanced)

The Yozio Match Transparency API is the latest technology in organic growth. Via this API Yozio passes the accuracy % of each click-to-install match to the app in real time enabling you to determine the right level of personalization while minimizing the risk of false positives. 

For each match click - install match, whether that match is 100% accurate or based on fingerprints between a user’s redirect click and an app open event, Yozio will return a number that indicates how confident we are about the match. Leverage these insights to determine what level of personalization each matched user receives based upon the match probability.  

Use this feature in campaigns and workflows which require high personalization on the user level, such as referrals and viral invites, and personalize the experience for each user with confidence. 

This API is for iOS only as Yozio Android SDK v1.1.9+  always provides 100% matching. Thus, no probability will be returned for Android. Please also note that Yozio is able to provide 100% confident matches on iOS as well. The Match Transparency API is critical for highly personalized workflows in instances where Yozio was not able to make a 100% match.

Prerequisites

  • For apps on the Free plan - a quick and 100% free chat with customer success, why & how to schedule 
  • ​Yozio iOS SDK v1.7 or above for iOS

Article Contents

Overview

With the matching accuracy probability returned, you may fine tune your personalization experience. For example, with this additional information, you may decide to show extremely personal onboarding experience only if the probability is higher than 90%, show a moderately personalized version if the probability is less than 90% but higher than 60%, and show a more generic version for anything lower than 60%.

Another use case for marketers may involve specifying a minimum confidence threshold and only when the matching probability is higher than that threshold is the installation event counted in the marketing statistics and the associated information compiled into the final marketing reports.

Setup

No setup is required if this feature is active for your Yozio account.

With this feature active, when you do the following API call:

1
Yozio:setAppKey:secretKey:metadataCallback

You will get back a field called “yozio_probability” in the returned metadata dictionary object in the metadata callback function. If there is no redirect click event match found for this install event, the probability returned is -1. If there is a match found, the probability returned will be a real number between 0 and 1. There are four pass-back scenarios. 

Case 1: Matching click found for new install, with associated metadata

For a new installation, if there is metadata pre-defined, e.g. a=1, b=2, c=3, the meta data passed back would be

1
2
3
4
5
6
7
8
9
{ 
    body = {
        a = "1"; b = "2"; c = "3";
        yozio_probability = 1"; 
        timestamp = 1409936057532; 
        yozio_device_id = b0dc3d4928f30c3d8836f5e3aacdd2b3f865f439; 
    }; 
    status = ok; 
}

The yozio_probability of 1 in this example indicates Yozio matched the click to install of the user with 100% confidence.

Case 2: Matching click found for new install, with no associated metadata

For a new installation, if there is no meta data pre-defined, the meta data passed back would be

1
2
3
4
5
6
7
8
{ 
    body = { 
        yozio_probability = 0.9874632123"; 
        timestamp = 1409936057532; 
        yozio_device_id = b0dc3d4928f30c3d8836f5e3aacdd2b3f865f439; 
        }; 
    status = ok; 
}

The yozio_probability of 0.987... in this example indicates Yozio calculated a 98.7% confidence level using advanced patent pending matching technology.

Case 3: No matching click found for new install

For a new installation, if there is no matching click found, the meta data passed back would be

1
2
3
4
5
6
7
8
{ 
    body = { 
        yozio_probability = -1";
        timestamp = 1409936057532;
        yozio_device_id = b0dc3d4928f30c3d8836f5e3aacdd2b3f865f439; 
        }; 
    status = ok;
}

As you can see, the match probability is -1, indicating that there was no match found.

Case 4: Application relaunch after installation

When a mobile application is launched after the initial installation, i.e. the application is opened after the first time it was opened, an empty dictionary is passed.

In cases 3 and 4, if you are expecting a match (for example, you are testing your integration) and you see a match probability of -1 or an empty dictionary, the cause is likely due to an implementation error. Contact us at [email protected] and we'll be happy to help.

Common Questions

Why don't I see a match probability returned to me?

The most common reasons are not meeting the prerequisites for this feature.  Prerequisites for the feature are:

  • ​Yozio iOS SDK v1.1.7 or above
  • Feature access, for apps on the Free plan- a quick and 100% free chat with customer success, why & how to schedule 

If you are all set on the above, then please note that if there is no redirect click event match found for an install event, the probability returned is -1, as this means no matching click event was found.

Note on Android: Yozio's Android SDK v1.1.9+ provide 100% accurate matching. Thus, no probability will be returned for Android as confidence is always 100%. 

Can Yozio match with 100% confidence?
Yes! On Android Yozio's matches are always 100% confident. On iOS Yozio can match with 100% in many situations. When a 100% match is achieved on iOS Yozio will return a probability of 1.

Why do free accounts need to chat with customer success before this feature is activated?
At Yozio, we treat every user as a partner and want everyone to be successful using our platform. Given the advanced and extremely powerful nature of the Yozio Match Transparency API, we like to chat with each of our partners before they leverage this API. This consult is quick, and NOT a sales call, promise. We simply want to ensure your success.

During the call we'd also be happy to chat about other things, so feel free to invite other members of your team to join, bring any questions you have or ideas for how you'd like to leverage Yozio. We'd be happy to answer your questions and share best practices with you and your team. 

To schedule, please email [email protected] or use the chat feature in the Yozio Console.