SuperLink APIs

This set of APIs allows you to create and manage SuperLinks using scripts, all without logging into the Yozio Console.

Check this article out to learn more about the difference between SuperLinks and SubLinks.

This API will allow you to create, update, and view all attributes currently supported with Yozio SuperLink via the Yozio SuperLink "New SuperLink" and "Edit" pages of the Yozio Console. There you may also find detailed explanations of SuperLink attributes.

A quick summary:

  • SuperLink short url: This is the SuperLink identifier. A sample short url for a SuperLink could be "/a.b.c".
  • SubLinks: Each SuperLink may have many, many SubLinks associated with it. Yozio automatically rolls up attribution stats for SubLinks to the SuperLink level.
  • Event attribution results: A SuperLink can be directly used for event attribution tracking purpose, such as impressions, clicks, installs, or downstream even conversions for things such as signup and payments.
  • The following attribution configuration:
    • Basic link information such as a unique link name, description, channel and use case tags.These do not impact SuperLink functionality and may be leveraged to organize your SuperLinks and segments across your Yozio dashboards.
    • Metadata
      • A SuperLink can have static metadata configured via Yozio Console or via API. Please see the metadata article for information on using static metadata for iOS and Android.
      • A SuperLink can also have its own dynamic metadata, i.e. a.b.c?&a=1&b=2
      • Metadata passing toggle which disables metadata when passing a user to a web url.
    • SuperLink alias: such as "/back-to-school-sale
      • the ability to disable the SuperLinks original short url
    • Redirect settings by platform: including deep link redirection
    • Advanced settings: such as Android Target Activity Class Name and Return to Browser Redirect Settings
    • Source / Ad partner server callbacks

The SuperLink API works over HTTP protocol and supports four basic options: Create, Update, List, and Get. Please note the following for all API operations:

  • URL endpoint: For all API operations implement a HTTP GET request to "http://api.yozio.com/v2.0/"
  • App key: For all API operations utilize your own app key. You can find your_app_key and your_secret_key by going to your app in the Yozio Console > SDK > Integration Info
  • User agent string: The user agent string of your http request cannot be empty

While there are many possible codes possibilities given the API operations covered below, you can see some code examples here.

This API will create a new SuperLink supporting all attributes you may find available on the Yozio SuperLink "New SuperLink" and "Edit" pages of the Yozio Console, and return the SuperLink short url immediately.

Please note that the max number of characters allowed for link name is 100. The "description" attribute is more appropriate for longer text.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
http://api.yozio.com/v2.0/?
app_key=YOUR_APP_KEY&
method=link.create&
name=Yozio+Email+Link&description=Link+from+email&link_alias=yozio_email_invite&
reassign_old_alias_to_this_link=true&disable_original_short_url=true&
android_target_activity_class_name=com.yozio.yozio_android_sample_app.SecondActivity
&override_default_iphone_settings=true&has_iphone_app=true&enable_iphone_deeplink=true
&iphone_use_custom_download_url=true&iphone_app_custom_download_url=http://www.apple.com
&iphone_deeplink_url=yozio://main/&override_default_ipad_settings=false
&override_default_android_settings=true&
android_google_play_url=https://play.google.com/store/apps/details?id=com.yozio.yozio_android_sample_app&
android_deeplink_url=yozio-sample-app-
scheme://&override_default_windows_settings=true&windows_url=http://www.bing.com&
override_default_fallback_settings=true&fallback_url=http://www.yozio.com

The response is in JSON format, and the result depends on your input. Here’s an example of the correct response for the example request above:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
{
    status: "ok",
    body: {
        short_url: "g.c.dk",
        name: "Yozio Email Link",
        description: "Link from email",
        link_alias: "yozio_email_invite",
        channel: null,
        use_case: null,
        meta_data: null,
        override_default_iphone_settings: true,
        has_iphone_app: true,
        enable_iphone_deeplink: true,
        iphone_no_app_url: null,
        iphone_itunes_url: null,
        iphone_app_custom_download_url: "http://www.apple.com",
        iphone_use_custom_download_url: true,
        iphone_deeplink_url: "yozio://main/",
        override_default_ipad_settings: false,
        has_ipad_app: null,
        enable_ipad_deeplink: null,
        ipad_no_app_url: null,
        ipad_itunes_url: null,
        ipad_app_custom_download_url: null,
        ipad_use_custom_download_url: null,
        ipad_deeplink_url: null,
        override_default_android_settings: true,
        has_android_app: null,
        enable_android_deeplink: null,
        android_no_app_url: null,
        android_google_play_url: "https://play.google.com/store/apps/details?id=com.yozio.yozio_android_sample_app",
        android_app_custom_download_url: null,
        android_use_custom_download_url: null,
        android_deeplink_url: "yozio-sample-app-scheme://",
        override_default_windows_settings: true,
        windows_url: "http://www.bing.com",
        override_default_fallback_settings: true,
        fallback_url: "http://www.yozio.com",
        android_target_activity_class_name: "com.yozio.yozio_android_sample_app.SecondActivity",
        disable_original_short_url: true,
        disable_meta_data_passing_to_web_url: false,
        timestamp: 1429912479021
}

This API allows you to update SuperLink without logging into the Yozio Console. It supports all attributes you may find available on the Yozio SuperLinks "New SuperLink" and "Edit" pages of the Yozio Console. Changes requested impact the SuperLink immediately.

Please note that the max number of characters allowed for link name is 100. The "description" attribute is more appropriate for longer text.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
http://api.yozio.com/v2.0/?
app_key=YOUR_APP_KEY&
method=link.update&
short_url=g.c.dk&
name=Yozio+Email+Link+Test+updated&description=Link+from+email&
link_alias=yozio_email_invite&reassign_old_alias_to_this_link=true&
disable_original_short_url=true&android_target_activity_class_name=
com.yozio.yozio_android_sample_app.SecondActivity&override_default_iphone_settings=true&
has_iphone_app=true&enable_iphone_deeplink=true&iphone_use_custom_download_url=true&
iphone_app_custom_download_url=http://www.apple.com&iphone_deeplink_url=yozio://main/&
override_default_ipad_settings=true&has_ipad_app=false&ipad_no_app_url=http://www.google.com&
override_default_android_settings=true&
android_google_play_url=https://play.google.com/store/apps/details?id=com.yozio.yozio_android_sample_app&
android_deeplink_url=yozio-sample-app-scheme://&override_default_windows_settings=true&windows_url=http://www.bing.com&
override_default_fallback_settings=true&fallback_url=http://www.yozio.com

The response is in JSON format, and the result depends on your input. Here’s an example of the correct response for the example request above:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
    status: "ok",
    body: {
        short_url: "g.c.dk",
        name: "Yozio Email Link Test updated",
        description: "Link from email",
        link_alias: "yozio_email_invite",
        channel: null,
        use_case: null,
        meta_data: null,
        override_default_iphone_settings: true,
        has_iphone_app: true,
        enable_iphone_deeplink: true,
        iphone_no_app_url: null,
        iphone_itunes_url: null,
        iphone_app_custom_download_url: "http://www.apple.com",
        iphone_use_custom_download_url: true,
        iphone_deeplink_url: "yozio://main/",
        override_default_ipad_settings: true,
        has_ipad_app: false,
        enable_ipad_deeplink: null,
        ipad_no_app_url: "http://www.google.com",
        ipad_itunes_url: null,
        ipad_app_custom_download_url: null,
        ipad_use_custom_download_url: null,
        ipad_deeplink_url: null,
        override_default_android_settings: true,
        has_android_app: null,
        enable_android_deeplink: null,
        android_no_app_url: null,
        android_google_play_url: "https://play.google.com/store/apps/details?id=com.yozio.yozio_android_sample_app",
        android_app_custom_download_url: null,
        android_use_custom_download_url: null,
        android_deeplink_url: "yozio-sample-app-scheme://",
        override_default_windows_settings: true,
        windows_url: "http://www.bing.com",
        override_default_fallback_settings: true,
        fallback_url: "http://www.yozio.com",
        android_target_activity_class_name: "com.yozio.yozio_android_sample_app.SecondActivity",
        disable_original_short_url: true,
        disable_meta_data_passing_to_web_url: false,
        timestamp: 1429912829652
    }
}

This will list all existing SuperLinks of a given app, identified by its app key, per page.

By default, this operation will return all links altogether. Optionally, You may use the pagination feature to get links returned by chunk of 10 links.

NAME TYPE MODIFIER DESCRIPTION
app_key string not null Your app key
method string not null Value must be "link.list"
page Integer Greater than 0, default value is 1
1
http://api.yozio.com/v2.0/?app_key=YOUR_APP_KEY&method=link.list&page=1

The response is in JSON format, and the result depends on your input and your app. You will have no more than 10 links in a single page. Here is an example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
{
    status: "ok",
        body: {
            data: [
                {
                    short_url: "g.c.dl",
                    name: "Yozio Email Link Test1",
                    description: "Link from email",
                    link_alias: "",
                    channel: null,
                    use_case: null,
                    meta_data: null,
                    override_default_iphone_settings: true,
                    has_iphone_app: true,
                    enable_iphone_deeplink: true,
                    iphone_no_app_url: null,
                    iphone_itunes_url: null,
                    iphone_app_custom_download_url: "http://www.apple.com",
                    iphone_use_custom_download_url: true,
                    iphone_deeplink_url: "yozio://main/",
                    override_default_ipad_settings: false,
                    has_ipad_app: null,
                    enable_ipad_deeplink: null,
                    ipad_no_app_url: null,
                    ipad_itunes_url: null,
                    ipad_app_custom_download_url: null,
                    ipad_use_custom_download_url: null,
                    ipad_deeplink_url: null,
                    override_default_android_settings: false,
                    has_android_app: null,
                    enable_android_deeplink: null,
                    android_no_app_url: null,
                    android_google_play_url: null,
                    android_app_custom_download_url: null,
                    android_use_custom_download_url: null,
                    android_deeplink_url: null,
                    override_default_windows_settings: true,
                    windows_url: "http://www.bing.com",
                    override_default_fallback_settings: true,
                    fallback_url: "http://www.yozio.com",
                    android_target_activity_class_name: "com.yozio.yozio_android_sample_app.SecondActivity",
                    disable_original_short_url: true,
                    disable_meta_data_passing_to_web_url: false
                },
                {
                    short_url: "g.c.df",
                    name: "old_api_test",
                    description: "old_api_test",
                    link_alias: "",
                    channel: null,
                    use_case: null,
                    meta_data: {
                        test: "old",
                        version: "1.0"
                    },
                    override_default_iphone_settings: true,
                    has_iphone_app: true,
                    enable_iphone_deeplink: true,
                    iphone_no_app_url: null,
                    iphone_itunes_url: "http://itunes.apple.com/a",
                    iphone_app_custom_download_url: null,
                    iphone_use_custom_download_url: false,
                    iphone_deeplink_url: "yozio://",
                    override_default_ipad_settings: true,
                    has_ipad_app: true,
                    enable_ipad_deeplink: null,
                    ipad_no_app_url: null,
                    ipad_itunes_url: "http://itunes.apple.com/a",
                    ipad_app_custom_download_url: null,
                    ipad_use_custom_download_url: false,
                    ipad_deeplink_url: null,
                    override_default_android_settings: null,
                    has_android_app: null,
                    enable_android_deeplink: null,
                    android_no_app_url: null,
                    android_google_play_url: null,
                    android_app_custom_download_url: null,
                    android_use_custom_download_url: null,
                    android_deeplink_url: null,
                    override_default_windows_settings: null,
                    windows_url: null,
                    override_default_fallback_settings: null,
                    fallback_url: null,
                    android_target_activity_class_name: "",
                    disable_original_short_url: false,
                    disable_meta_data_passing_to_web_url: false
                },
                ...
            ],
            timestamp: 1426449670129
    }
}

This API will display all the attributes of a particular given SuperLink of a particular app, identified by its app key and short url.

NAME TYPE MODIFIER DESCRIPTION
app_key string not null Your app key
method string not null Value must be "link.get"
short_url string not null Represent the Yozio SuperLink id that you want to get, ie: "a.b.c".
1
http://api.yozio.com/v2.0/?app_key=YOUR_APP_KEY&method=link.get&short_url=g.c.dk

The response is in JSON format and results depend upon your SuperLink. Here’s an example of the correct response for the example request above:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
    status: "ok",
    body: {
        short_url: "g.c.dk",
        name: "Yozio Email Link Test updated",
        description: "Link from email",
        link_alias: "yozio_email_invite",
        channel: null,
        use_case: null,
        meta_data: null,
        override_default_iphone_settings: true,
        has_iphone_app: true,
        enable_iphone_deeplink: true,
        iphone_no_app_url: null,
        iphone_itunes_url: null,
        iphone_app_custom_download_url: "http://www.apple.com",
        iphone_use_custom_download_url: true,
        iphone_deeplink_url: "yozio://main/",
        override_default_ipad_settings: true,
        has_ipad_app: false,
        enable_ipad_deeplink: null,
        ipad_no_app_url: "http://www.google.com",
        ipad_itunes_url: null,
        ipad_app_custom_download_url: null,
        ipad_use_custom_download_url: null,
        ipad_deeplink_url: null,
        override_default_android_settings: true,
        has_android_app: null,
        enable_android_deeplink: null,
        android_no_app_url: null,
        android_google_play_url: "https://play.google.com/store/apps/details?id=com.yozio.yozio_android_sample_app",
        android_app_custom_download_url: null,
        android_use_custom_download_url: null,
        android_deeplink_url: "yozio-sample-app-scheme://",
        override_default_windows_settings: true,
        windows_url: "http://www.bing.com",
        override_default_fallback_settings: true,
        fallback_url: "http://www.yozio.com",
        android_target_activity_class_name: "com.yozio.yozio_android_sample_app.SecondActivity",
        disable_original_short_url: true,
        disable_meta_data_passing_to_web_url: false,
        timestamp: 1429912829652
    }
}