Event Track API

Overview

The Yozio Event Tracking API allows you to track deep links and other downstream events such as signup and payment in your app without integrating the Yozio SDK. You can also fire downstream events from your servers; for instance, a cash payment done outside the app can still be tracked using the Yozio Event Tracking API. All that’s required is the app key, secret key, the event name, OS, and the short url; with these, any events you post to our API will be tracked and reflected on the Yozio Console.

By default, the install events will not need to be tracked separately; when the install attribution API finds a match between a click and install event, it will also track the install on the Yozio Dashboard. Tracking an install event using the Event Track API will result in double counting of your install stats.

You can also fire events from anywhere, not just from inside your app. For example, if a user used your app to book a service, but made a payment in cash, you can fire a payment event through your servers! This opens up many possibilities to use the Yozio Dashboard in ways that were previously limited by an SDK. Feel free to experiment, and we'll be more than happy to advise.

Firing a Downstream Event

Whether on Android or iOS, to let the Yozio Backend know that an event was fired, call the Event Track API. To do this, make an HTTPS GET request to the endpoint

https://api.yozio.com/v2.0/?method=event.track

Below are the parameters you must add to track a downstream event:

Required Parameters

Name Description Example
app_key Log in Yozio Console, click "SDK" on the left sidebar and App Key is available at that page. 99e90a1a-f07a-42db-926d-0be333b726c6
secret_key Log in Yozio Console, click “SDK” on the left sidebar and Secret Key is available at that page. 4a532adf-aca3-4935-bec5-529376796650
event_name The name of the event, as registered in the Yozio Console deeplink
short_url the short url that identifies Yozio SuperLinks. F.c.c
os The operating system of the device. It will use user agent os if not provided android

Optional Parameters

Name Description Example
properties dictionary containing metadata, which can be viewed later when using the data export features. properties[country] = US
event_timestamp The timestamp of the event. It will use user agent timestamp (server timestamp, or the time when the event hits our servers) if not provided 1454974771846
event_value The numerical value of the event, for example a payment value 234

One of the things to note is that you should be firing downstream and deep link events when you know for sure an event comes from Yozio. This means you should be checking in the metadata for the key value pairs __y=1 and __ydl=1. These pieces of metadata indicate that the deep link or app opening resulted from a click on a Yozio SuperLink.

Additionally, note that one of the required parameters is the short_url. This is the string that uniquely identifies each SuperLink. If you have a SuperLink r.yoz.io/a.b.c for example, the short_url would be a.b.c. Make sure that you keep this piece of data inside your app and have it accessible globally; any downstream events or deep link events will need this short_url, to make sure that the events are posted to the correct SuperLink on the Yozio Dashboard

Verifying a Downstream Event was tracked

To verify a downstream event was tracked, simply make a call to the Event Track API with all the required parameters. Expect the following responses on success and failure:

API call succeeds and event is posted
{
    "status": "ok",
}
API call fails
{
    "status": "error",
    "message": "[error message]" // format of error msg may change
}