Links API is an API for listing, creating, and modifying SmartLink™ resources.
App Group
Create: This endpoint can be used to create an App Group.
Endpoint:
POST: https://links.api.kochava.com/v1/groups
Header: Authentication-Key: {MyUserAPIKey}
NOTE: An App cannot be added to more than one App Group and an App Group may only contain one instance of each platform. Please ensure the Apps that you are grouping are not already included in another App Group and each have a distinct App platform (iOS, Android, Fire OS, Web, etc).
Request Body:
{
"name": "My New App Group Name",
"account_id": 5899,
"is_active": true,
"apps": [
24171,
26538
]
}Response Body:
{
"status": 200,
"is_agency": false,
"data": {
"id": 123,
"name": "My App Group Name",
"account_id": 5099,
"apps": [
{
"app_id": 24131,
"name": "My App Name - iOS",
"platform": "ios",
"eligible_for_smartlinks": true
},
{
"app_id": 26528,
"name": "My App Name - Android",
"platform": "android",
"eligible_for_smartlinks": true
}
],
"created_dttm": 1571244640,
"last_updated_dttm": 1571244640,
"is_active": true,
"eligible_for_smartlinks": true
}
}Get: This endpoint can be used to retrieve a specific App Group.
Endpoint:
GET: https://links.api.kochava.com/v1/groups/id
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of an App Group to look up. Example: 123 |
Number |
Response Body:
{
"status": 200,
"is_agency": true,
"data": {
"id": 123,
"name": "My App Group Name",
"account_id": 5899,
"apps": [
{
"app_id": 24171,
"name": "My App Name - iOS",
"platform": "ios",
"eligible_for_smartlinks": true
},
{
"app_id": 26538,
"name": "My App Name - Android",
"platform": "android",
"eligible_for_smartlinks": true
}
],
"created_dttm": 1571244640,
"last_updated_dttm": 1571244640,
"is_active": true,
"eligible_for_smartlinks": true
}
}Update: This endpoint can be used to change the name of an App Group and/or add new Apps to the App Group.
NOTE: There are restrictions on what Apps can be added to an App Group. An App cannot be added to more than one App Group and an App Group may only contain one instance of each platform. Please ensure the Apps that you are adding are not already included in another App Group and each App included has a distinct platform (iOS, Android, Fire OS, Web, etc).
NOTE: Apps cannot be removed from an App Group. If an App needs to be removed, the App Group as a whole can be archived, as long as there are no active SmartLinks™ remaining for the App Group. You can then recreate the App Group with the desired list of Apps.
NOTE: If the intent is to only change the App Group name, the list of Apps currently in the group must be passed in the Update request as well, similar to how it is passed on the Create request.
Endpoint:
PUT:https://links.api.kochava.com/v1/groups/id
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of the app group to edit. Example: 123 |
Number |
Request Body:
{
"name": "My App Group Name",
"apps": [
24171,
26538
]
}Response Body:
{
"status": 200,
"is_agency": false,
"data": {
"id": 123,
"name": "My App Group Name",
"account_id": 5809,
"apps": [
{
"app_id": 36396,
"name": "My App Name - iOS",
"platform": "ios",
"eligible_for_smartlinks": true
},
{
"app_id": 36395,
"name": "My App Name - Android",
"platform": "android",
"eligible_for_smartlinks": true
}
],
"created_dttm": 1571244640,
"last_updated_dttm": 1571244640,
"is_active": true,
"eligible_for_smartlinks": true
}
}Archive: This endpoint is used to archive an App Group.
NOTE: This action cannot be reversed.
Endpoint:
PUT: https://links.api.kochava.com/v1/groups/id/archive
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of the app group to archive. Example: 123 |
Number |
Response Body:
{
"status": 200,
"is_agency": false
}List Subdomains: This endpoint can be used to retrieve a list of Subdomains.
Endpoint:
GET: https://links.api.kochava.com/v1/groups/id/subdomains
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The app group id to update. Example: 123. |
Number |
Response Body:
{
"status": 200,
"is_agency": false,
"data": {
"app_group_id": 123,
"subdomains": [
{
"common_subdomain": "your_brand_name",
"link_domain": "your_brand_name.smart.link",
"apps": [
{
"app_id": 1234,
"fallback_url": "https://kochava1.com"
},
{
"app_id": 5678,
"fallback_url": "https://kochava2.com"
}
],
"default": true
},
{
"common_subdomain": "your_brand_name2",
"link_domain": "your_brand_name2.smart.link",
"apps": [
{
"app_id": 1234,
"fallback_url": "https://kochava1.com"
}
]
}
]
}
}List: This endpoint can be used to retrieve a list of App Groups.
Endpoint:
GET: https://links.api.kochava.com/v1/groups?is_active=true&search=prod&page=2&page_size=10&sort=name&platform=android%2Cios&account=5&has_write_access=1
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| account | An account to filter the results to. Helpful for requests made by Agency users who may work with more than one advertiser. Example: 10246. |
Number |
| has_written_access | Indicates that the API key has the ability to create SmartLinks™ Resources for the App Group. This is useful in the case of Agency users who may have read-only access to some App Groups. Example: 1. |
String |
| is_active | Filter on active/inactive. If is_active = false, that means the App Group was archived. Example: true. |
Boolean |
| page_size | The number of items to return per page. Example: 10 Default: 25. |
Number |
| page | The page number of the result set to retrieve. Example: 2 Default: 1. |
Number |
| platform | Comma separated list of platforms to filter app groups by. Options include android, androidtv, chromecast, daydream, htcvive, ios, kindle, linux, macosx, nintendoswitch, nintendowiiu, oculusgo, oculusrift, playstation, roku, samsunggearvr, tizenos, tvos, viziosmartcastos, web, webgl, webos, windows, windowsxbox. | String |
| search | Filter App Groups by the given search value. Search values can be full/partial App Group Name or App Name. | String |
| sort | The value and direction to sort by. Options include name_asc, name_desc, smartlink_count_asc, smartlink_count_desc, app_count_asc, app_count_desc, created_asc, created_desc. Default: created_asc. |
String |
| sort | The value and direction to sort by. Options include name_asc, name_desc, smartlink_count_asc, smartlink_count_desc, app_count_asc, app_count_desc, created_asc, created_desc. Default: created_asc. |
String |
Response Body:
{
"status": 200,
"is_agency": false,
"data": [
{
"id": 123,
"name": "App Group Name 1",
"apps": [
{
"app_id": 24111,
"name": "App Name 1 - iOS",
"platform": "ios"
},
{
"app_id": 26538,
"name": "App Name 1 - Android",
"platform": "android"
}
],
"app_count": 2,
"smartlink_count": 0,
"created_dttm": 0,
"can_create_smartlinks": true
},
{
"id": 124,
"name": "App Group Name 2",
"apps": [
{
"app_id": 57,
"name": "App Name 2 - Android",
"platform": "android"
},
{
"app_id": 1387,
"name": "App Name 2 - iOS ",
"platform": "ios"
}
],
"app_count": 2,
"smartlink_count": 0,
"created_dttm": 0,
"can_create_smartlinks": true
},
{
"id": 423,
"name": "App Group Name 3",
"apps": [
{
"app_id": 17,
"name": "App Name 3 - Android",
"platform": "android"
},
{
"app_id": 1147,
"name": "App Name 3 - iOS",
"platform": "ios"
},
{
"app_id": 15568,
"name": "App Name 3 - Web",
"platform": "web"
}
],
"app_count": 3,
"smartlink_count": 0,
"created_dttm": 0,
"can_create_smartlinks": true
}
]
}App Group Campaigns
List: This endpoint can be used to retrieve a list of App Group Campaigns for a given App Group.
App Group Campaigns are Campaigns that are shared across all Apps in an App Group. Multiple SmartLinks™ can be assigned to an App Group Campaign.
NOTE: App Group Campaigns are separate and distinct from the Campaigns created via the Campaign API. You cannot add trackers created in the Campaign API to App Group Campaigns and you cannot add SmartLinks™ to Campaigns created via the Campaign API.
Endpoint:
GET: https://links.api.kochava.com/v1/groups/id/campaigns?is_deleted
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The app group id to get the campaigns for. Example: 123. |
Number |
| is_deleted | Filter on whether or not the campaign is deleted. Default is to omit deleted campaigns. Example: false. |
Bool |
Response Body:
[
{
"id": 444,
"app_group_id": 123,
"name": "My App Group Campaign Name 1",
"created_dttm": 1574707263,
"last_updated_dttm": 1574707263,
"is_active": true
},
{
"id": 421,
"app_group_id": 123,
"name": "My App Group Campaign Name 2",
"created_dttm": 1574707123,
"last_updated_dttm": 1574707123,
"is_active": true
}
]Check: This endpoint can be used to check an App Group Campaign.
App Group Campaigns are Campaigns that are shared across all Apps in an App Group. Multiple SmartLinks™ can be assigned to an App Group Campaign.
NOTE: App Group Campaigns are separate and distinct from the Campaigns created via the Campaign API. You cannot add trackers created in the Campaign API to App Group Campaigns and you cannot add SmartLinks™ to Campaigns created via the Campaign API.
Endpoint:
POST: https://links.api.kochava.com/v1/groups/id/campaigns/check
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The app group id to check the campaigns for. Example: 123. |
Number |
Response Body:
200Create: This endpoint can be used to create an App Group Campaign.
App Group Campaigns are Campaigns that are shared across all Apps in an App Group. Multiple SmartLinks™ can be assigned to an App Group Campaign.
NOTE: App Group Campaigns are separate and distinct from the Campaigns created via the Campaign API. You cannot add trackers created in the Campaign API to App Group Campaigns and you cannot add SmartLinks™ to Campaigns created via the Campaign API.
Endpoint:
POST: https://links.api.kochava.com/v1/groups/id/campaigns?
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The app group id to create the campaign for. Example: 123. |
Number |
Request Body:
{
"name": "My Campaign Name"
}Update: This endpoint can be used to update a App Group Campaign.
App Group Campaigns are Campaigns that are shared across all Apps in an App Group. Multiple SmartLinks™ can be assigned to an App Group Campaign.
NOTE: App Group Campaigns are separate and distinct from the Campaigns created via the Campaign API. You cannot add trackers created in the Campaign API to App Group Campaigns and you cannot add SmartLinks™ to Campaigns created via the Campaign API.
Endpoint:
POST: https://links.api.kochava.com/v1/groups/id/campaigns/campaign_id
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The app group id to update the campaigns for. Example: 123. |
Number |
| campaign_id | The campaign id to update. Example: 123. |
Number |
Response Body:
{
"id": 444,
"app_group_id": 123,
"name": "A Campaign Name",
"created_dttm": 1574707263,
"last_updated_dttm": 1574707263,
"is_active": true
}Advertisers
Get: This endpoint can be used to get a list of Advertisers.
This endpoint can be used to get a list of Advertisers where the API key has either read or write access to at least one of the Advertiser’s App Groups. Useful for Agency users who may work with more than one Advertiser.
Endpoint:
GET: https://links.api.kochava.com/v1/advertisers?has_write_access=true
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| has_write_access | Filter on whether the API key has write access to at least one of the Advertiser’s App Groups. This is useful for Agency users who may have read-only or write access to an App Group. | Boolean |
Response Body:
{
"status": 200,
"is_agency": false,
"data": [
{
"id": 23543,
"name": "Account Name 1"
"has_write_access": false
},
{
"id": 20331,
"name": "Account Name 2",
"has_write_access": true
}
]
}Agencies
List: This endpoint can be used to retrieve a list of Agencies a SmartLink™ can be associated to.
Endpoint:
GET: https://links.api.kochava.com/v1/agency_networks
Header: Authentication-Key: {MyUserAPIKey}
Response Body:
{
"status": 200,
"is_agency": false,
"data": [
{
"id": 234,
"name": "Agency A",
"acl": 4,
"logo_url": "/logo/agency_a.png"
},
{
"id": 235,
"name": "Agency B",
"acl": 4,
"logo_url": "/logo/agency_b.png"
},
{
"id": 100000,
"name": "Agency C",
"acl": 4,
"logo_url": "/logo/agency_c.png"
}
]
}Media Partners
List: This endpoint can be used to retrieve a list of integrated SmartLink™ Media Partners and Private Networks the SmartLink™ can be associated to.
Endpoint:
GET: https://links.api.kochava.com/v1/networks?vppn_app_id=30000%C30001
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| vppn_app_id | OPTIONAL FILTER: Specify list of apps and receive a list of private networks associated to those apps. Excluding this filter will return all networks (universal and private). Example: 30000,30001. |
String |
Response Body:
{
"status": 200,
"is_agency": false,
"data": [
{
"id": 122,
"name": "Universal Network A",
"acl": 5,
"logo_url": "/logo/universal_network_a"
},
{
"id": 123,
"name": "Universal Network B",
"acl": 5,
"logo_url": "/logo/universal_network_a"
},
{
"id": 125,
"name": "Private Network",
"acl": 2,
"logo_url": ""
}
]
}SmartLinks™ without iOS Universal Link or Android App Link Support
Check Name: This endpoint can be used to check a SmartLink™ name.
Endpoint:
POST: https://links.api.kochava.com/v1/links/check/name
Header: Authentication-Key: {MyUserAPIKey}
Request Body:
{
"app_group_id": 1,
"name": "my great link"
}Response:
200Create: This endpoint can be used to create a SmartLink™.
NOTE: App platforms eligible to be included in SmartLink™ routes are the following: “Android”, “iOS”, “Web” (Desktop), “Kindle” (Fire OS), “Macosx” (macOS), “Windows”. App Groups may contain additional platforms, however those will be omitted from SmartLink™ routes.
Endpoint:
POST: https://links.api.kochava.com/v1/links
Header: Authentication-Key: {MyUserAPIKey}
Request Body:
| Name | Parameter | Description |
|---|---|---|
| App Group ID | app_group_id | ID of the App Group. |
| Network ID | network_id | ID of the Media Partner. For none, use 3881. |
| Agency ID | agency_network_id | ID of the Agency. For none, use null. |
| App Group Campaign ID | app_group_campaign_id | Only one of app_group_campaign_id or app_group_campaign_name is required. In order to assign a SmartLink™ to an existing App Group Campaign, populate app_group_campaign_id with an existing App Group ID and populate app_group_campaign_name with null or omit the parameter. In order to create a new App Group Campaign, populate app_group_campaign_name with a new App Group Campaign Name and populate app_group_campaign_id with null or omit the parameter. |
| App Group Campaign Name | app_group_campaign_name | Only one of app_group_campaign_id or app_group_campaign_name is required. In order to assign a SmartLink™ to an existing App Group Campaign, populate app_group_campaign_id with an App Group ID and populate app_group_campaign_name with null or omit the parameter. In order to create a new App Group Campaign, populate app_group_campaign_name with a new App Group Campaign Name and populate app_group_campaign_id with null or omit the parameter. |
| Ad Pricing Model | network_price | Options: CPC (Cost per Click), CPI (Cost per Install), CPM (Cost per Impression), CPA (Cost per Action) |
| Ad Price | network_pricing | This amount will be assigned to the traffic depending on the Ad Pricing Model. For example if CPI $1 and the SmartLink™ click or impression is attributed to an install, that install will have a install price of $1. |
| Custom Parameter Key | custom_params > key | These key/value pairs will be added to the SmartLink™ URL. |
| Custom Parameter Value | custom_params > value | These key/value pairs will be added to the SmartLink™ URL. |
| SmartLink Name | name | The name of the SmartLink™. |
| Catch-All App | default > app_id | Traffic that does not match any of the platforms included within the defined routes will be stored under this App, under a Kochava-generated Tracker name: “Catch-all tracker for [SmartLink Name]”. |
| Catch-All Destination | default > destination_url | Users clicking on devices that do not match any of the platforms included within the defined routes will be redirected to this destination. Typically your website. |
| Routes by App | routes_by_app | Define destinations and conversion events by App/platform. |
| Conversion App | routes_by_app > app_id | Apps included must belong to the App Group. |
| Conversion Events | routes_by_app > events | List of Events you would like this SmartLink’s™ traffic to attribute to. Can be _Install and/or Post-install Events. These conversion Events should match the Event names sent to Kochava from the Conversion App. |
| Routes | routes_by_app > routes | Define the Tracker name, “if app is installed” and “if app is not installed” destinations, and the platform of the App. |
| Tracker Name | routes_by_app > routes > name | The name of the Tracker for this route (app/platform-specific). |
| Channel Type | channel_type | Whether the channel is owned or paid. |
| “If App is Not Installed” Destination | routes_by_app > routes > destination_url | Destination to take the user to if the app is not installed on the device. Typically the app store. |
| “If App is Installed” Destination | routes_by_app > routes > reenagement_url | Destination to take the user to if the app is already installed on the device. Typically a deep link that will open the app and/or take the user to a specific destination within the app. |
| Platform of the Route | routes_by_app > routes > rules > platform_in | The platform designated should match that of the conversion app, as well as the destinations specified for the given route. Upon a user clicking on a SmartLink™, Kochava will detect the platform and route the user to the appropriate destinations. Options: “Android”, “iOS”, “Web” (Desktop), “Kindle” (Fire OS), “Macosx” (macOS), “Windows”. |
{
"app_group_id": 5160,
"network_id": 3881,
"agency_network_id": null,
"app_group_campaign_id": 5181,
"app_group_campaign_name": null,
"network_pricing": "cpi",
"network_price": 0.99,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"name": "My SmartLink Name",
"channel_type": "owned",
"default": {
"app_id": 36403,
"destination_url": "https://www.mywebsitedestination.com/"
},
"routes_by_app": [
{
"app_id": 36396,
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"reengagement_url": "myApp://",
"rules": {
"platform_in": [
"iOS"
]
}
}
]
},
{
"app_id": 36395,
"events": [
"Purchase"
],
"routes": [
{
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"reengagement_url": "myApp://checkout",
"rules": {
"platform_in": [
"Android"
]
}
}
]
},
{
"app_id": 36403,
"events": [
"Trial Page Visit"
],
"routes": [
{
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/",
"rules": {
"platform_in": [
"Web"
]
}
}
]
}
]
}Response Body:
"status": 200,
"is_agency": false,
"data": {
"id": 102713,
"guid": "hl9cu118hdv17",
"app_group_id": 5160,
"app_group_campaign_id": 5181,
"app_group_campaign_name": "My App Group Campaign Name",
"network_pricing": "cpi",
"network_price": 0.99,
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My SmartLink Name",
"channel_type": "owned",
"click_url": "https://smart.link/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://smart.link/imp/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035186,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 36403,
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"app_guid": "kojeh-test-9-sawx",
"legacy_tracker_id": "b9135dedfa83e",
"campaign_id": 13033554019,
"app_name": "My App Name",
"app_platform": "web"
},
"routes_by_app": [
{
"app_id": 36396,
"app_guid": "koskd-test-2-7uyfn",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035187,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"reengagement_url": "myApp://",
"legacy_tracker_id": "09bbde5046e23",
"campaign_id": 13033554017,
"rules": {
"platform_in": [
"iOS"
]
},
"is_default": true
}
]
},
{
"app_id": 36395,
"app_guid": "kosdf-test-1-wkd61",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035188,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"reengagement_url": "myApp://checkout",
"legacy_tracker_id": "c2eb394af914b",
"campaign_id": 13033554018,
"rules": {
"platform_in": [
"Android"
]
},
"is_default": true
}
]
},
{
"app_id": 36403,
"app_guid": "kosdf-test-9-sawx",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035189,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "d43adb81c9209",
"campaign_id": 13033554019,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1586994101,
"last_updated_dttm": 1586994101,
"editable": true
}
}Get: This endpoint can be used to retrieve a specific SmartLink™.
Endpoint:
GET: https://links.api.kochava.com/v1/links/id
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of the SmartLink™ to look up. Example: 123. |
Number |
Response Body:
{
"status": 200,
"is_agency": false,
"data": {
"id": 102713,
"guid": "hl9cu118hdv17",
"app_group_id": 5160,
"app_group_campaign_id": 5181,
"app_group_campaign_name": "My App Group Campaign Name",
"network_pricing": "cpi",
"network_price": 0.99,
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My SmartLink Name",
"click_url": "https://smart.link/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://smart.link/imp/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035186,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 36403,
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"app_guid": "kosdfd-test-9-sawx",
"legacy_tracker_id": "b9135dedfa83e",
"campaign_id": 13033554019,
"app_name": "My App Name",
"app_platform": "web",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 36396,
"app_guid": "kovsdfd-test-2-7uyfn",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035187,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"reengagement_url": "myApp://",
"legacy_tracker_id": "09bbde5046e23",
"campaign_id": 13033554017,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"iOS"
]
},
"is_default": true
}
]
},
{
"app_id": 36395,
"app_guid": "kodfds-test-1-wkd61",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035188,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"reengagement_url": "myApp://checkout",
"legacy_tracker_id": "c2eb394af914b",
"campaign_id": 13033554018,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Android"
]
},
"is_default": true
}
]
},
{
"app_id": 36403,
"app_guid": "kodsfds-test-9-sawx",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035189,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "d43adb81c9209",
"campaign_id": 13033554019,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1586994101,
"last_updated_dttm": 1586994101,
"click_count": 0,
"install_count": 0,
"editable": true
}
}Get QR Code: This endpoint can be used to retrieve a specific QR Code.
The QR code returned will follow the style format dictated by the account settings; either Black and White (Generic) or SmartLinks™ (Kochava-branded).
Endpoint:
GET: https://links.api.kochava.com/v1/links/id/qr?format=svg&size=256
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of the SmartLink™ ID. Example: 123. |
Number |
| format | Image format for the QR code. png, jpg, svg Example: svg Default: png. |
String |
| size | desired size of the outputed qr code image. 0: as small as possible. < 0: scaling multiplier. > 0: number of pixels wide/high. Note: svg currently only uses scaling multiplier. Example: 256 Default: 0. |
Integer |
Response:
22Response Body:
<image file data>Update: This endpoint can be used to update an existing SmartLink™.
NOTE: For simplicity, the entire response from a GET can be sent as an update. Some fields will be ignored, but any changes will be considered and applied if permissible.
CAUTION: Please ensure the “id” fields, found within “data”, “default”, and “routes” have the original values from the GET response. Leaving the id fields blank or changing the value will cause the SmartLink™ to become disassociated from the underlying App-specific Trackers, which may cause routing and attribution issues.
Endpoint:
PUT: https://links.api.kochava.com/v1/links/id
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of the SmartLink™ to update. Example: 123. |
Number |
Request Body:
NOTE: Parameters that can be updated include the following:
| Name | Parameter | Description |
|---|---|---|
| Agency ID | agency_network_id | ID of the Agency. For none, use null. |
| App Group Campaign ID | app_group_campaign_id | Only one of app_group_campaign_id or app_group_campaign_name is required. In order to assign a SmartLink™ to an existing App Group Campaign, populate app_group_campaign_id with an App Group ID and populate app_group_campaign_name with null or omit the parameter. In order to create a new App Group Campaign, populate app_group_campaign_name with a new App Group Campaign Name and populate app_group_campaign_id with null or omit the parameter. |
| Ad Pricing Model | network_pricing | Options: CPC (Cost per Click), CPI (Cost per Install), CPM (Cost per Impression), CPA (Cost per Action) |
| Ad Price | network_price | This amount will be assigned to the traffic depending on the Ad Pricing Model. For example if CPI $1 and the SmartLink™ click or impression is attributed to an install, that install will have a install price of $1. |
| Custom Parameter Key | custom_params > key | These key/value pairs will be added to the SmartLink™ URL. |
| Custom Parameter Value | custom_params > value | These key/value pairs will be added to the SmartLink™ URL. |
| SmartLink Name | name | The name of the SmartLink™. |
| Catch-All App | default > app_id | Traffic that does not match any of the platforms included within the defined routes will be stored under this App, under a Kochava-generated Tracker name: “Catch-all tracker for [SmartLink Name]”. |
| Catch-All Destination | default > destination_url | Users clicking on devices that do not match any of the platforms included within the defined routes will be redirected to this destination. Typically your website. |
| Conversion Events | routes_by_app > events | List of Events you would like this SmartLink’s™ traffic to attribute to. Can be _Install and/or Post-install Events. These conversion Events should match the Event names sent to Kochava from the Conversion App. |
| Tracker Name | routes_by_app > routes > name | The name of the Tracker for this route (app/platform-specific). |
| “If App is Not Installed” Destination | routes_by_app > routes > destination_url | Destination to take the user to if the app is not installed on the device. Typically the app store. |
| “If App is Installed” Destination | routes_by_app > routes > reenagement_url | Destination to take the user to if the app is already installed on the device. Typically a deep link that will open the app and/or take the user to a specific destination within the app. |
{
"id": 102713,
"guid": "hl9cu228hdv17",
"app_group_id": 5160,
"app_group_campaign_id": 5181,
"app_group_campaign_name": "My App Group Campaign Name",
"network_pricing": "cpi",
"network_price": 0.99,
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My Updated SmartLink Name",
"click_url": "https://smart.link/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://smart.link/imp/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035186,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 36403,
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"app_guid": "kosdfd-test-9-sawx",
"legacy_tracker_id": "b9135dedfa83e",
"campaign_id": 13033554019,
"app_name": "My App Name",
"app_platform": "web",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 36396,
"app_guid": "kovsdfd-test-2-7uyfn",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035187,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"reengagement_url": "myApp://",
"legacy_tracker_id": "09bbde5046e23",
"campaign_id": 13033554017,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"iOS"
]
},
"is_default": true
}
]
},
{
"app_id": 36395,
"app_guid": "kodfds-test-1-wkd61",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035188,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"reengagement_url": "myApp://checkout",
"legacy_tracker_id": "c2eb394af914b",
"campaign_id": 13033554018,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Android"
]
},
"is_default": true
}
]
},
{
"app_id": 36403,
"app_guid": "kodsfds-test-9-sawx",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035189,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "d43adb81c9209",
"campaign_id": 13033554019,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1586994101,
"last_updated_dttm": 1586994101,
"click_count": 0,
"install_count": 0,
"editable": true }Response Body:
{
"status": 200,
"is_agency": false,
"data": {
"id": 102713,
"guid": "hl9cu228hdv17",
"app_group_id": 5160,
"app_group_campaign_id": 5181,
"app_group_campaign_name": "My App Group Campaign Name",
"network_pricing": "cpi",
"network_price": 0.99,
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My Updated SmartLink Name",
"click_url": "https://smart.link/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://smart.link/imp/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035186,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 36403,
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"app_guid": "kosdf-test-9-sawx",
"legacy_tracker_id": "b9135dedfa83e",
"campaign_id": 13033554019,
"app_name": "My App Name",
"app_platform": "web",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 36396,
"app_guid": "kodfd-test-2-7uyfn",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035187,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"reengagement_url": "myApp://",
"legacy_tracker_id": "09bbde5046e23",
"campaign_id": 13033554017,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"iOS"
]
},
"is_default": true
}
]
},
{
"app_id": 36395,
"app_guid": "kosdf-test-1-wkd61",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035188,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"reengagement_url": "myApp://checkout",
"legacy_tracker_id": "c2eb394af914b",
"campaign_id": 13033554018,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Android"
]
},
"is_default": true
}
]
},
{
"app_id": 36403,
"app_guid": "kodfd-test-9-sawx",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035189,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "d43adb81c9209",
"campaign_id": 13033554019,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1586994101,
"last_updated_dttm": 1587058332,
"click_count": 0,
"install_count": 0,
"editable": true
}
}Archive: This endpoint can be used to archive a SmartLink™.
PUT: https://links.api.kochava.com/v1/links/id/archive
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of the SmartLink™ to archive. Example: 123. |
Number |
Response Body:
{ “status”: 200, “is_agency”: false }List: This endpoint can be used to retrieve a list of SmartLinks™.
Endpoint:
GET: https://links.api.kochava.com/v1/links?app_group_id=123%2C321&advertiser_account_id=23&is_active=true&search=inmobi&page=2&page_size=10&sort=name
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| app_group_id | App Group(s) to filter on – can be a single id or a comma delimited list of ids. Example: 123,321. |
String |
| advertiser_account_id | Advertiser Account ID to filter on. Example: 123. |
Number |
| is_active | Filter on active/inactive. If is_active = false, that means the SmartLink™ was archived. Example: true. |
Boolean |
| search | Filter SmartLinks™ by the given search value. Search values can be full/partial SmartLink Name, SmartLink URL, Partner Name, Agency Name. Example: inmobi. |
String |
| page_size | The number of items to return per page. Example: 10 Default: 25. |
Number |
| page | The page number of the result set to retrieve. Example: 2 Default: 1. |
Number |
| sort | The value: (name, created, updated) and direction to sort by: (asc, desc) Example: name Default: created_asc. |
String |
Response Body:
{
"status": 200,
"is_agency": false,
"data": [
{
"id": 102713,
"guid": "hl9cu228hdv17",
"app_group_id": 5160,
"app_group_campaign_id": 5181,
"app_group_campaign_name": "My App Group Campaign Name",
"network_pricing": "",
"network_price": 0,
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My Updated SmartLink Name",
"click_url": "https://smart.link/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://smart.link/imp/hl9cu118hdv17?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035186,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 36403,
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"app_guid": "kodfd-test-9-sawx",
"legacy_tracker_id": "b9135dedfa83e",
"campaign_id": 13033554019,
"app_name": "My App Name",
"app_platform": "web",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 36396,
"app_guid": "kodfs-test-2-7uyfn",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035187,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"reengagement_url": "myApp://",
"legacy_tracker_id": "09bbde5046e23",
"campaign_id": 13033554017,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"iOS"
]
},
"is_default": true
}
]
},
{
"app_id": 36395,
"app_guid": "kosdf-test-1-wkd61",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035188,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"reengagement_url": "myApp://checkout",
"legacy_tracker_id": "c2eb394af914b",
"campaign_id": 13033554018,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Android"
]
},
"is_default": true
}
]
},
{
"app_id": 36403,
"app_guid": "kodfsds-test-9-sawx",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035189,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "d43adb81c9209",
"campaign_id": 13033554019,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1586994101,
"last_updated_dttm": 1587058332,
"click_count": 0,
"install_count": 0,
"editable": true
},
{
"id": 102691,
"guid": "akowt7ejx1hq6",
"app_group_id": 5160,
"app_group_campaign_id": 5181,
"app_group_campaign_name": "My App Group Campaign Name",
"network_pricing": "",
"network_price": 0,
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": false,
"name": "My SmartLink Name",
"click_url": "https://smart.link/akowt6ejx1hq6?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://smart.link/imp/akowt6ejx1hq6?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035087,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 36403,
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"app_guid": "kosdf-test-9-sawx",
"legacy_tracker_id": "5b9c209213128",
"campaign_id": 13033554019,
"app_name": "My App Name",
"app_platform": "web",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 36396,
"app_guid": "koxdf-test-2-7uyfn",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035088,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"reengagement_url": "myApp://",
"legacy_tracker_id": "92e359c10a8d1",
"campaign_id": 13033554017,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"iOS"
]
},
"is_default": true
}
]
},
{
"app_id": 36395,
"app_guid": "kosdfsa-test-1-wkd61",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035089,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"reengagement_url": "myApp://checkout",
"legacy_tracker_id": "4e2de94fb9175",
"campaign_id": 13033554018,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Android"
]
},
"is_default": true
}
]
},
{
"app_id": 36403,
"app_guid": "kosaberw-test-9-sawx",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035090,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "6bd2257b8c2e7",
"campaign_id": 13033554019,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1586983089,
"last_updated_dttm": 1586983089,
"click_count": 0,
"install_count": 0,
"editable": true
}
]
}SmartLinks™ with iOS Universal Link and Android App Link Support
Check Name: This endpoint can be used to check a SmartLink™ name.
Endpoint:
POST: https://links.api.kochava.com/v1/links/check/name
Header: Authentication-Key: {MyUserAPIKey}
Request Body:
{
"app_group_id": 1,
"name": "my great link"
}Response:
200Create: This endpoint can be used to create a SmartLink™ that contains an iOS App with Kochava-hosted Universal Link support, as well as an Android App with Kochava-hosted App Link support.
A prerequisite to this is completing the integration requirements for Kochava-hosted Universal Links and App Links. More information can be found here.
NOTE: App platforms eligible to be included in SmartLink™ routes are the following: “Android”, “iOS”, “Web” (Desktop), “Kindle” (Fire OS), “Macosx” (macOS), “Windows”. App Groups may contain additional platforms, however those will be omitted from SmartLink™ routes.
Endpoint:
POST: https://links.api.kochava.com/v1/links
Header: Authentication-Key: {MyUserAPIKey}
Request Body:
| Name | Parameter | Description |
|---|---|---|
| App Group ID | app_group_id | ID of the App Group. |
| “If App is Installed” Destination | path | Destination to take the user to if the app is already installed on the device. Typically a deep link that will open the app and/or take the user to a specific destination within the app. The “path” value will be applied to any routes that contain “native_link”: “ios” or “native_link”: “android”. |
| Network ID | network_id | ID of the Media Partner. For none, use 3881. |
| Agency ID | agency_network_id | ID of the Agency. For none, use null. |
| App Group Campaign ID | app_group_campaign_id | Only one of app_group_campaign_id or app_group_campaign_name is required. In order to assign a SmartLink™ to an existing App Group Campaign, populate app_group_campaign_id with an existing App Group ID and populate app_group_campaign_name with null or omit the parameter. In order to create a new App Group Campaign, populate app_group_campaign_name with a new App Group Campaign Name and populate app_group_campaign_id with null or omit the parameter. |
| App Group Campaign Name | app_group_campaign_name | Only one of app_group_campaign_id or app_group_campaign_name is required. In order to assign a SmartLink™ to an existing App Group Campaign, populate app_group_campaign_id with an App Group ID and populate app_group_campaign_name with null or omit the parameter. In order to create a new App Group Campaign, populate app_group_campaign_name with a new App Group Campaign Name and populate app_group_campaign_id with null or omit the parameter. |
| Ad Pricing Model | network_price | Options: CPC (Cost per Click), CPI (Cost per Install), CPM (Cost per Impression), CPA (Cost per Action) |
| Ad Price | network_pricing | This amount will be assigned to the traffic depending on the Ad Pricing Model. For example if CPI $1 and the SmartLink™ click or impression is attributed to an install, that install will have a install price of $1. |
| Custom Parameter Key | custom_params > key | These key/value pairs will be added to the SmartLink™ URL. |
| Custom Parameter Value | custom_params > value | These key/value pairs will be added to the SmartLink™ URL. |
| SmartLink Name | name | The name of the SmartLink™. |
| Catch-All App | default > app_id | Traffic that does not match any of the platforms included within the defined routes will be stored under this App, under a Kochava-generated Tracker name: “Catch-all tracker for [SmartLink Name]”. |
| Catch-All Destination | default > destination_url | Users clicking on devices that do not match any of the platforms included within the defined routes will be redirected to this destination. Typically your website. |
| Routes by App | routes_by_app | Define destinations and conversion events by App/platform. |
| Conversion App | routes_by_app > app_id | Apps included must belong to the App Group. |
| Conversion Events | routes_by_app > events | List of Events you would like this SmartLink’s™ traffic to attribute to. Can be _Install and/or Post-install Events. These conversion Events should match the Event names sent to Kochava from the Conversion App. |
| Routes | routes_by_app > routes | Define the Tracker name, “if app is installed” and “if app is not installed” destinations, and the platform of the App. |
| Tracker Name | routes_by_app > routes > name | The name of the Tracker for this route (app/platform-specific). |
| Channel Type | channel_type | Whether the channel is owned or paid. |
| “If App is Not Installed” Destination | routes_by_app > routes > destination_url | Destination to take the user to if the app is not installed on the device. Typically the app store. |
| Universal Link/App Link Flag | routes_by_app > routes > native_link | Insert “ios” as the value for a iOS Universal Link-enabled route. Insert “android” as the value for an Android App Link-enabled route. |
{
"app_group_id": 4833,
"subdomain": "boss",
"path": "myApp://",
"network_id": 3881,
"agency_network_id": null,
"app_group_campaign_id": null,
"app_group_campaign_name": "New Campaign Name",
"network_pricing": "cpi",
"network_price": 0.99,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"name": "My SmartLink Name",
"channel_type": "owned",
"default": {
"app_id": 24171,
"destination_url": "https://www.mywebsitedestination.com/"
},
"routes_by_app": [
{
"app_id": 24171,
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"native_link": "ios"
}
]
},
{
"app_id": 26538,
"events": [
"Purchase"
],
"routes": [
{
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"native_link": "android"
}
]
},
{
"app_id": 38581,
"events": [
"Trial Page Visit"
],
"routes": [
{
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/",
"rules": {
"platform_in": [
"Web"
]
}
}
]
}
]
}Response Body:
{
"status": 200,
"is_agency": false,
"data": {
"id": 102714,
"guid": "gl4ufwxhm",
"subdomain": "your_brand_name",
"app_group_id": 4833,
"app_group_campaign_id": 5208,
"app_group_campaign_name": "New Campaign Name",
"network_pricing": "cpi",
"network_price": 0.99,
"path": "myApp://",
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My SmartLink Name",
"click_url": "https://your_brand_name.smart.link/gl4ufwxhm?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://your_brand_name.smart.link/imp/gl4ufwxhm?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"channel_type": "owned",
"default": {
"id": 13034035190,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 24171,
"destination_url": "https://www.mywebsitedestination.com/",
"app_guid": "kodjfklds-ios-4fkz131i",
"legacy_tracker_id": "a4a3b8dca253e",
"campaign_id": 13033554164,
"app_name": "My App Name",
"app_platform": "ios"
},
"routes_by_app": [
{
"app_id": 24171,
"app_guid": "kosfadsae-ios-4fkz131i",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035191,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"legacy_tracker_id": "e0ed02080c223",
"campaign_id": 13033554164,
"rules": {
"platform_in": [
"ios"
]
},
"native_link": "ios",
"is_default": true
}
]
},
{
"app_id": 26538,
"app_guid": "koasdfdsa-android-tewdf",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035192,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"legacy_tracker_id": "901231209e360",
"campaign_id": 13033554165,
"rules": {
"platform_in": [
"android"
]
},
"native_link": "android",
"is_default": true
}
]
},
{
"app_id": 38581,
"app_guid": "kosdfds-web-j87qn6",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035193,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "f460019c2fde8",
"campaign_id": 13033554166,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1586994364,
"last_updated_dttm": 1586994364,
"editable": true
}
}Get: This endpoint can be used to retrieve a specific SmartLink™.
Endpoint:
GET: https://links.api.kochava.com/v1/links/id
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of the SmartLink™ to look up. Example: 123. |
Number |
Response Body:
{
"status": 200,
"is_agency": false,
"data": {
"id": 102746,
"guid": "s83nfmw5c",
"subdomain": "your_brand_name",
"app_group_id": 4833,
"app_group_campaign_id": 5221,
"app_group_campaign_name": "New Campaign Name",
"network_pricing": "cpi",
"network_price": 0.99,
"path": "myApp://",
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My SmartLink Name",
"click_url": "https://your_brand_name.smart.link/s83nfmw5c?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://your_brand_name.smart.link/imp/s83nfmw5c?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035378,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 24171,
"destination_url": "https://www.mywebsitedestination.com/",
"app_guid": "kosdfdsa-ios-4fkz131i",
"legacy_tracker_id": "e0872b2dc77fc",
"campaign_id": 13033554261,
"app_name": "My App Name",
"app_platform": "ios",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 24171,
"app_guid": "kosasfdsa-4fkz131i",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035379,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"legacy_tracker_id": "9c5b611c15719",
"campaign_id": 13033554261,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"ios"
]
},
"native_link": "ios",
"is_default": true
}
]
},
{
"app_id": 26538,
"app_guid": "kosdfdsdfs-tewdf",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035380,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"legacy_tracker_id": "8c096e9c611d0",
"campaign_id": 13033554262,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"android"
]
},
"native_link": "android",
"is_default": true
}
]
},
{
"app_id": 38581,
"app_guid": "kosdfdsafds-j87qn6",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035381,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "43c96859d8945",
"campaign_id": 13033554263,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1587067601,
"last_updated_dttm": 1587067601,
"click_count": 0,
"install_count": 0,
"editable": true
}
}Get QR Code: This endpoint can be used to retrieve a specific QR Code.
The QR code returned will follow the style format dictated by the account settings; either Black and White (Generic) or SmartLinks™ (Kochava-branded).
Endpoint:
GET: https://links.api.kochava.com/v1/links/id/qr?format=svg&size=256
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of the SmartLink™ ID. Example: 123. |
Number |
| format | Image format for the QR code. png, jpg, svg Example: svg Default: png. |
String |
| size | desired size of the outputed qr code image. 0: as small as possible. < 0: scaling multiplier. > 0: number of pixels wide/high. Note: svg currently only uses scaling multiplier. Example: 256 Default: 0. |
Integer |
Response:
22Response Body:
<image file data>Update: This endpoint can be used to update an existing SmartLink™.
The SmartLink™ contains an iOS App with Kochava-hosted Universal Link support, as well as an Android App with Kochava-hosted App Link support.
NOTE: For simplicity, the entire response from a GET can be sent as an update. Some fields will be ignored, but any changes will be considered and applied if permissible.
CAUTION: Please ensure the “id” fields, found within “data”, “default”, and “routes” have the original values from the GET response. Leaving the id fields blank or changing the value will cause the SmartLink™ to become disassociated from the underlying App-specific Trackers, which may cause routing and attribution issues.
Endpoint:
PUT: https://links.api.kochava.com/v1/links/id
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The Smart Link id. Example: 123. |
Number |
Request Body:
NOTE: Parameters that can be updated include the following:
| Name | Parameter | Description |
|---|---|---|
| “If App is Installed” Destination | path | Destination to take the user to if the app is already installed on the device. Typically a deep link that will open the app and/or take the user to a specific destination within the app. The “path” value will be applied to any routes that contain “native_link”: “ios” or “native_link”: “android”. |
| Agency ID | agency_network_id | ID of the Agency. For none, use null. |
| App Group Campaign Name | app_group_campaign_name | Only one of app_group_campaign_id or app_group_campaign_name is required. In order to assign a SmartLink™ to an existing App Group Campaign, populate app_group_campaign_id with an App Group ID and populate app_group_campaign_name with null or omit the parameter. In order to create a new App Group Campaign, populate app_group_campaign_name with a new App Group Campaign Name and populate app_group_campaign_id with null or omit the parameter. |
| Ad Pricing Model | network_pricing | Options: CPC (Cost per Click), CPI (Cost per Install), CPM (Cost per Impression), CPA (Cost per Action) |
| Ad Price | network_price | This amount will be assigned to the traffic depending on the Ad Pricing Model. For example if CPI $1 and the SmartLink™ click or impression is attributed to an install, that install will have a install price of $1. |
| Custom Parameter Key | custom_params > key | These key/value pairs will be added to the SmartLink™ URL. |
| Custom Parameter Value | custom_params > value | These key/value pairs will be added to the SmartLink™ URL. |
| SmartLink Name | name | The name of the SmartLink™. |
| Catch-All App | default > app_id | Traffic that does not match any of the platforms included within the defined routes will be stored under this App, under a Kochava-generated Tracker name: “Catch-all tracker for [SmartLink Name]”. |
| Catch-All Destination | default > destination_url | Users clicking on devices that do not match any of the platforms included within the defined routes will be redirected to this destination. Typically your website. |
| Conversion Events | routes_by_app > events | List of Events you would like this SmartLink’s traffic to attribute to. Can be _Install and/or Post-install Events. These conversion Events should match the Event names sent to Kochava from the Conversion App. |
| Tracker Name | routes_by_app > routes > name | The name of the Tracker for this route (app/platform-specific). |
| “If App is Not Installed” Destination | routes_by_app > routes > destination_url | Destination to take the user to if the app is not installed on the device. Typically the app store. |
{
"id": 102746,
"guid": "s83nfmw5c",
"subdomain": "your_brand_name",
"app_group_id": 4833,
"app_group_campaign_id": 5221,
"app_group_campaign_name": "My Campaign Name",
"network_pricing": "cpi",
"network_price": 0.99,
"path": "myApp://",
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My Updated SmartLink Name",
"click_url": "https://your_brand_name.smart.link/s83nfmw5c?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://your_brand_name.smart.link/imp/s83nfmw5c?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035378,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 24171,
"destination_url": "https://www.mywebsitedestination.com/",
"app_guid": "kosdfdsafdsa-4fkz131i",
"legacy_tracker_id": "e0872b2dc77fc",
"campaign_id": 13033554261,
"app_name": "My App Name",
"app_platform": "ios",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 24171,
"app_guid": "kosdfdsafdsa-4fkz131i",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035379,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"legacy_tracker_id": "9c5b611c15719",
"campaign_id": 13033554261,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"ios"
]
},
"native_link": "ios",
"is_default": true
}
]
},
{
"app_id": 26538,
"app_guid": "kodsafdsafd-tewdf",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035380,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"legacy_tracker_id": "8c096e9c611d0",
"campaign_id": 13033554262,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"android"
]
},
"native_link": "android",
"is_default": true
}
]
},
{
"app_id": 38581,
"app_guid": "kosdfadsafd-j87qn6",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035381,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "43c96859d8945",
"campaign_id": 13033554263,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1587067601,
"last_updated_dttm": 1587067601,
"click_count": 0,
"install_count": 0,
"editable": true
}Response Body:
{
"status": 200,
"is_agency": false,
"data": {
"id": 102746,
"guid": "s83nfmw5c",
"subdomain": "your_brand_name",
"app_group_id": 4833,
"app_group_campaign_id": 5221,
"app_group_campaign_name": "New Campaign Name",
"network_pricing": "cpi",
"network_price": 0.99,
"path": "myApp://",
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My Updated SmartLink Name",
"click_url": "https://your_brand_name.smart.link/s83nfmw5c?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://your_brand_name.smart.link/imp/s83nfmw5c?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035378,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 24171,
"destination_url": "https://www.mywebsitedestination.com/",
"app_guid": "kosdfsafds-ios-4fkz131i",
"legacy_tracker_id": "e0872b2dc77fc",
"campaign_id": 13033554261,
"app_name": "My App Name",
"app_platform": "ios",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 24171,
"app_guid": "kosdfsafds-ios-4fkz131i",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035379,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"legacy_tracker_id": "9c5b611c15719",
"campaign_id": 13033554261,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"ios"
]
},
"native_link": "ios",
"is_default": true
}
]
},
{
"app_id": 26538,
"app_guid": "kosfdsfds-tewdf",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035380,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"legacy_tracker_id": "8c096e9c611d0",
"campaign_id": 13033554262,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"android"
]
},
"native_link": "android",
"is_default": true
}
]
},
{
"app_id": 38581,
"app_guid": "kosdfdsfds-j87qn6",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035381,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "43c96859d8945",
"campaign_id": 13033554263,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1587067601,
"last_updated_dttm": 1587068893,
"click_count": 0,
"install_count": 0,
"editable": true
}
}Archive: This endpoint can be used to archive a SmartLink™.
Endpoint:
PUT: https://links.api.kochava.com/v1/links/id/archive
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| id | The ID of the SmartLink™ to archive. Example: 123. |
Number |
Response Body:
{
"status": 200,
"is_agency": false
}List: This endpoint can be used to retrieve a list of SmartLinks™.
Endpoint:
GET: https://links.api.kochava.com/v1/links?app_group_id=123%2C321&advertiser_account_id=23&is_active=true&search=inmobi&page=2&page_size=10&sort=name
Header: Authentication-Key: {MyUserAPIKey}
Parameters:
| Parameter | Description | Format |
|---|---|---|
| app_group_id | App Group(s) to filter on – can be a single id or a comma delimited list of ids. Example: 123,321. |
String |
| advertiser_account_id | Advertiser Account ID to filter on. Example: 123. |
Number |
| is_active | Filter on active/inactive. If is_active = false, that means the SmartLink™ was archived. Example: true. |
Boolean |
| search | Filter SmartLinks™ by the given search value. Search values can be full/partial SmartLink Name, SmartLink URL, Partner Name, Agency Name. Example: inmobi. |
String |
| page_size | The number of items to return per page. Example: 10 Default: 25. |
Number |
| page | The page number of the result set to retrieve. Example: 2 Default: 1. |
Number |
| sort | The value: (name, created, updated) and direction to sort by: (asc, desc) Example: name Default: created_asc. |
String |
Response Body:
{
"status": 200,
"is_agency": false,
"data": [
{
"id": 102745,
"guid": "6qb01dgjj",
"subdomain": "your_brand_name",
"app_group_id": 4833,
"app_group_campaign_id": 5220,
"app_group_campaign_name": "My Campaign Name",
"network_pricing": "",
"network_price": 0,
"path": "myApp://",
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My SmartLink Name",
"click_url": "https://your_brand_name.smart.link/6qb01dgjj?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://your_brand_name.smart.link/imp/6qb01dgjj?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035374,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 24171,
"destination_url": "https://www.mywebsitedestination.com/",
"app_guid": "kosafdsfds-4fkz131i",
"legacy_tracker_id": "7a0ba9a4e5337",
"campaign_id": 13033554258,
"app_name": "My App Name",
"app_platform": "ios",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 24171,
"app_guid": "kosdfdsafds-4fkz131i",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035375,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"legacy_tracker_id": "00e14810cf225",
"campaign_id": 13033554258,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"ios"
]
},
"native_link": "ios",
"is_default": true
}
]
},
{
"app_id": 26538,
"app_guid": "kosadfdsafdsa-tewdf",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035376,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"legacy_tracker_id": "8fb8a4a5dd467",
"campaign_id": 13033554259,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"android"
]
},
"native_link": "android",
"is_default": true
}
]
},
{
"app_id": 38581,
"app_guid": "kosafdsafdsa-j87qn6",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035377,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "76198a2b1ad50",
"campaign_id": 13033554260,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1587067077,
"last_updated_dttm": 1587067078,
"click_count": 0,
"install_count": 0,
"editable": true
},
{
"id": 102714,
"guid": "gl4ufwxhm",
"subdomain": "your_brand_name",
"app_group_id": 4833,
"app_group_campaign_id": 5208,
"app_group_campaign_name": "My Campaign Name",
"network_pricing": "",
"network_price": 0,
"path": "myApp://",
"network_id": 3881,
"custom_params": [
{
"key": "example_key_1",
"value": "example_value_1"
},
{
"key": "example_key_2",
"value": "example_value_2"
},
{
"key": "example_key_3",
"value": "example_value_3"
}
],
"is_active": true,
"name": "My SmartLink Name",
"click_url": "https://your_brand_name.smart.link/gl4ufwxhm?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"impression_url": "https://your_brand_name.smart.link/imp/gl4ufwxhm?example_key_1=example_value_1&example_key_2=example_value_2&example_key_3=example_value_3",
"app_group_name": "My App Group Name",
"network_name": "SmartLinks",
"account_name": "My Account Name",
"default": {
"id": 13034035190,
"name": "Catch-all tracker for smartlink My SmartLink Name",
"app_id": 24171,
"destination_url": "https://www.mywebsitedestination.com/",
"app_guid": "kosdfasfds-4fkz131i",
"legacy_tracker_id": "a4a3b8dca253e",
"campaign_id": 13033554164,
"app_name": "My App Name",
"app_platform": "ios",
"click_count": 0,
"install_count": 0
},
"routes_by_app": [
{
"app_id": 24171,
"app_guid": "kodsafdsafdsa-4fkz131i",
"app_name": "My App Name",
"app_platform": "ios",
"events": [
"_Install",
"Checkout Start"
],
"routes": [
{
"id": 13034035191,
"name": "My iOS Tracker Name",
"destination_url": "https://apps.apple.com/us/app/myapp/id123456789",
"legacy_tracker_id": "e0ed02080c223",
"campaign_id": 13033554164,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"ios"
]
},
"native_link": "ios",
"is_default": true
}
]
},
{
"app_id": 26538,
"app_guid": "kosdfasfdsa-tewdf",
"app_name": "My App Name",
"app_platform": "android",
"events": [
"Purchase"
],
"routes": [
{
"id": 13034035192,
"name": "My Android Tracker Name",
"destination_url": "https://play.google.com/store/apps/details?id=com.myapp.ongoogleplay",
"legacy_tracker_id": "901231209e360",
"campaign_id": 13033554165,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"android"
]
},
"native_link": "android",
"is_default": true
}
]
},
{
"app_id": 38581,
"app_guid": "kosdfasdafds-j87qn6",
"app_name": "My App Name",
"app_platform": "web",
"events": [
"Trial Page Visit"
],
"routes": [
{
"id": 13034035193,
"name": "My Web Tracker Name",
"destination_url": "https://www.mywebsitedestination.com/?ko_click_id={click_id}",
"legacy_tracker_id": "f460019c2fde8",
"campaign_id": 13033554166,
"click_count": 0,
"install_count": 0,
"rules": {
"platform_in": [
"Web"
]
},
"is_default": true
}
]
}
],
"created_dttm": 1586994364,
"last_updated_dttm": 1586994364,
"click_count": 0,
"install_count": 0,
"editable": true
}
]
}