1. Home
  2. Marketers
  3. Advanced Tools
  4. App Management API
  1. Home
  2. Marketers
  3. App Management API
Searching...

App Management API

Contents


The following document defines and provides samples for Premium Publisher API calls for the management of apps within Kochava.

Get All Apps API

The Get All API call provides a list of apps that your account has ownership of.

NOTE: This will not return Apps Running Media if you are a Publisher or Premium Publisher.

Request Parameters:

pageToken —

By default this API will return all of your account owned apps. You can trigger pagination by specifying “1” for the pageToken and doing so returns 50 results per page. previousToken and nextToken is used to navigate backward and forward respectively.

Type —

String

Required —

No

Response Parameters:

nextToken —

Used to retrieve the next page of results. When the last page of data is reached then NULL will be returned.

Type —

String

previousToken —

Used to retrieve the previous page of results. When the first page of data is reached then NULL will be returned.

Type —

String

Full Detail Data Sample Request:

GET: https://apps.api.kochava.com/apps?app_selector=false
Header: Authentication-Key: {MyUserAPIKey}

Sample Response:

>[
  {
    "id": 17090,
    "guid": "koconversions-demo-3ixhy8",
    "package_code": "",
    "path": "/koconversions-demo-3ixhy8/",
    "cluster_analytics": 0,
    "cluster_control": 17,
    "registered": "2016-06-18T07:35:32Z",
    "updated": "2016-06-18T07:35:32Z",
    "session_tracking": "full",
    "traffic_processing": "active",
    "ibeacon_enabled": true,
    "deleted": false,
    "push_enabled": false,
    "sms_enabled": false,
    "app_universal_link_enabled": false,
    "fraud_blacklist": false,
    "name": "Conversions Demo",
    "platform": "android",
    "sku": "",
    "integration_type": "native-android",
    "facebook_app_id": "",
    "kochava_app_url": "",
    "app_store_id": "",
    "twilio_account_sid": "",
    "twilio_basic_auth": "",
    "twilio_from_number": "",
    "aws_region": "",
    "aws_bucket": "",
    "aws_access_key": "",
    "aws_secret_key": "",
    "request_time_pref": "",
    "overwrite_origination_ip": false,
    "use_short_version_string": false,
    "api_access_enabled": true,
    "currency_processing": false,
    "sdk_blacklist_mac": true,
    "sdk_blacklist_odin": true,
    "sdk_blacklist_open_udid": true,
    "sdk_blacklist_fb_attribution_id": true,
    "sdk_blacklist_android_id": true,
    "sdk_blacklist_imei": true,
    "sdk_blacklist_prefer_adid_only": true,
    "sdk_blacklist_adid": true,
    "sdk_blacklist_idfv": true,
    "sdk_blacklist_bssid": true,
    "sdk_blacklist_ssid": true,
    "sdk_blacklist_wp80_device_unique_id": true,
    "sdk_blacklist_waid": true,
    "sdk_blacklist_limit_ad_tracking": true,
    "sdk_blacklist_affinity_group": true,
    "sdk_whitelist_email": false,
    "sdk_whitelist_location": false,
    "sdk_blacklist_iad": false,
    "sdk_iad_retry_wait": "",
    "sdk_iad_attempts": "",
    "sdk_iad_wait": "",
    "sdk_send_id_updates": false,
    "sdk_override_adid": false,
    "disregard_organic_events": false,
    "whatif_parent": 0,
    "use_install_referrer_begin_time": false,
    "consent_region": "none",
    "consent_prompt_retry_interval": 2592000,
    "consent_prompt_id": "",
    "consent_partners": null,
    "context": null
  },
  {
    "id": 17089,
    "guid": "koaubtest-blacklist-defaults-sprinkler-v1-2-8-t4g9",
    "package_code": "",
    "path": "/koaubtest-blacklist-defaults-sprinkler-v1-2-8-t4g9/",
    "cluster_analytics": 0,
    "cluster_control": 10,
    "registered": "2016-06-20T22:11:21Z",
    "updated": "2016-06-20T22:11:21Z",
    "session_tracking": "minimal",
    "traffic_processing": "active",
    "ibeacon_enabled": true,
    "deleted": false,
    "push_enabled": false,
    "sms_enabled": false,
    "app_universal_link_enabled": false,
    "fraud_blacklist": false,
    "name": "AUBTEST :: blacklist defaults :: Sprinkler v1.2.8",
    "platform": "android",
    "sku": "",
    "integration_type": "native-android",
    "facebook_app_id": "",
    "kochava_app_url": "",
    "app_store_id": "",
    "twilio_account_sid": "",
    "twilio_basic_auth": "",
    "twilio_from_number": "",
    "aws_region": "",
    "aws_bucket": "",
    "aws_access_key": "",
    "aws_secret_key": "",
    "request_time_pref": "",
    "overwrite_origination_ip": false,
    "use_short_version_string": false,
    "api_access_enabled": true,
    "currency_processing": false,
    "sdk_blacklist_mac": true,
    "sdk_blacklist_odin": true,
    "sdk_blacklist_open_udid": true,
    "sdk_blacklist_fb_attribution_id": true,
    "sdk_blacklist_android_id": true,
    "sdk_blacklist_imei": true,
    "sdk_blacklist_prefer_adid_only": true,
    "sdk_blacklist_adid": true,
    "sdk_blacklist_idfv": true,
    "sdk_blacklist_bssid": true,
    "sdk_blacklist_ssid": true,
    "sdk_blacklist_wp80_device_unique_id": true,
    "sdk_blacklist_waid": true,
    "sdk_blacklist_limit_ad_tracking": true,
    "sdk_blacklist_affinity_group": true,
    "sdk_whitelist_email": false,
    "sdk_whitelist_location": false,
    "sdk_blacklist_iad": false,
    "sdk_iad_retry_wait": "",
    "sdk_iad_attempts": "",
    "sdk_iad_wait": "",
    "sdk_send_id_updates": false,
    "sdk_override_adid": false,
    "disregard_organic_events": false,
    "whatif_parent": 0,
    "use_install_referrer_begin_time": false,
    "consent_region": "none",
    "consent_prompt_retry_interval": 2592000,
    "consent_prompt_id": "",
    "consent_partners": null,
    "context": null
  }
]

Limited Detail Sample Request:

GET: https://apps.api.kochava.com/apps?app_selector=true
Header: Authentication-Key: {MyUserAPIKey}

Sample Response:

[
  {
    "id": 17090,
    "guid": "koconversions-demo-3ixhy8",
    "deleted": false,
    "push_enabled": false,
    "sms_enabled": true,
    "app_universal_link_enabled": false,
    "name": "Conversions Demo",
    "platform": "android",
    "app_store_id": "",
    "app_store_info": {
      "app_icon": "https://lh3.googleusercontent.com/ujGR6tbawZpfhybJJI8jXZvoMIiaQ-bfnG0ZuwZ1NXA-e71jLp9vXq7B7Qkm60s1YAY"
    }
  },
  {
    "id": 17089,
    "guid": "koaubtest-blacklist-defaults-sprinkler-v1-2-8-t4g9",
    "deleted": false,
    "push_enabled": false,
    "sms_enabled": true,
    "app_universal_link_enabled": false,
    "name": "AUBTEST :: blacklist defaults :: Sprinkler v1.2.8",
    "platform": "android"
  }
]

Get Single App

This API is used to retrieve a single app by providing the API the numerical app ID to look up.

Sample Request Without App Store Information:

GET: https://apps.api.kochava.com/app/app_id?app_store_info=false
Header: Authentication-Key: {MyUserAPIKey}

NOTE: If no flag is provided, the app store information will not be included by default.

Sample Response:

>{
  "account_id": 5,
  "id": 17090,
  "guid": "koconversions-demo-3ixhy8",
  "package_code": "android5",
  "path": "/koconversions-demo-3ixhy8/",
  "cluster_analytics": 0,
  "cluster_control": 17,
  "registered": "2016-06-18T07:35:32Z",
  "updated": "2016-06-18T07:35:32Z",
  "session_tracking": "full",
  "traffic_processing": "active",
  "ibeacon_enabled": true,
  "deleted": false,
  "push_enabled": false,
  "sms_enabled": true,
  "app_universal_link_enabled": false,
  "fraud_blacklist": false,
  "name": "Conversions Demo",
  "platform": "android",
  "sku": "",
  "integration_type": "native-android",
  "facebook_app_id": "",
  "kochava_app_url": "",
  "app_store_id": "",
  "twilio_account_sid": "AQWUIUH1731203bAAHbdas",
  "twilio_basic_auth": "Basic VGhpcyBpc24ndCByZWFsLiBCdXQgaGV5XCEK",
  "twilio_from_number": "12088675309",
  "aws_region": "us-west-2",
  "aws_bucket": "reports_kochava",
  "aws_access_key": "AGGBVCCDRSD",
  "aws_secret_key": "xxGDGHJHJYUUXXXXXXXX/XXC",
  "request_time_pref": "",
  "overwrite_origination_ip": false,
  "use_short_version_string": false,
  "api_access_enabled": true,
  "currency_processing": false,
  "sdk_blacklist_mac": true,
  "sdk_blacklist_odin": true,
  "sdk_blacklist_open_udid": true,
  "sdk_blacklist_fb_attribution_id": true,
  "sdk_blacklist_android_id": true,
  "sdk_blacklist_imei": true,
  "sdk_blacklist_prefer_adid_only": true,
  "sdk_blacklist_adid": true,
  "sdk_blacklist_idfv": true,
  "sdk_blacklist_bssid": true,
  "sdk_blacklist_ssid": true,
  "sdk_blacklist_wp80_device_unique_id": true,
  "sdk_blacklist_waid": true,
  "sdk_blacklist_limit_ad_tracking": true,
  "sdk_blacklist_affinity_group": true,
  "sdk_whitelist_email": false,
  "sdk_whitelist_location": false,
  "sdk_blacklist_iad": false,
  "sdk_iad_retry_wait": "",
  "sdk_iad_attempts": "",
  "sdk_iad_wait": "",
  "sdk_send_id_updates": false,
  "sdk_override_adid": false,
  "disregard_organic_events": false,
  "whatif_parent": 0,
  "use_install_referrer_begin_time": false,
  "consent_region": "none",
  "consent_prompt_retry_interval": 2592000,
  "consent_prompt_id": "",
  "consent_partners": null,
  "events": [
    {
      "id": 462929867,
      "name": "_Click",
      "name_norm": "_click",
      "is_revenue": false,
      "is_active": true
    },
    {
      "id": 465655964,
      "name": "_SessionBegin",
      "name_norm": "_sessionbegin",
      "is_revenue": false,
      "is_active": true
    },
    {
      "id": 465655965,
      "name": "_Install",
      "name_norm": "_install",
      "custom_dimensions": [
        {
          "id": 305344146,
          "name": "receipt_status",
          "name_norm": "receipt_status",
          "is_active": true
        }
      ],
      "is_revenue": false,
      "is_active": true
    }
  ],
  "context": null
}

Sample Request With App Store Information:

GET: https://apps.api.kochava.com/app/app_id?app_store_info=true
Header: Authentication-Key: {MyUserAPIKey}

Sample Response:

>{
  "account_id": 5,
  "id": 17090,
  "guid": "koconversions-demo-3ixhy8",
  "package_code": "android5",
  "path": "/koconversions-demo-3ixhy8/",
  "cluster_analytics": 0,
  "cluster_control": 17,
  "registered": "2016-06-18T07:35:32Z",
  "updated": "2016-06-18T07:35:32Z",
  "session_tracking": "full",
  "traffic_processing": "active",
  "ibeacon_enabled": true,
  "deleted": false,
  "push_enabled": false,
  "sms_enabled": true,
  "app_universal_link_enabled": false,
  "fraud_blacklist": false,
  "name": "Conversions Demo",
  "platform": "android",
  "sku": "",
  "integration_type": "native-android",
  "facebook_app_id": "",
  "kochava_app_url": "",
  "app_store_id": "azerty.023.q",
  "twilio_account_sid": "AQWUIUH1731203bAAHbdas",
  "twilio_basic_auth": "Basic VGhpcyBpc24ndCByZWFsLiBCdXQgaGV5XCEK",
  "twilio_from_number": "12088675309",
  "aws_region": "us-west-2",
  "aws_bucket": "reports_kochava",
  "aws_access_key": "AGGBVCCDRSD",
  "aws_secret_key": "xxGDGHJHJYUUXXXXXXXX/XXC",
  "request_time_pref": "",
  "overwrite_origination_ip": false,
  "use_short_version_string": false,
  "api_access_enabled": true,
  "currency_processing": false,
  "sdk_blacklist_mac": true,
  "sdk_blacklist_odin": true,
  "sdk_blacklist_open_udid": true,
  "sdk_blacklist_fb_attribution_id": true,
  "sdk_blacklist_android_id": true,
  "sdk_blacklist_imei": true,
  "sdk_blacklist_prefer_adid_only": true,
  "sdk_blacklist_adid": true,
  "sdk_blacklist_idfv": true,
  "sdk_blacklist_bssid": true,
  "sdk_blacklist_ssid": true,
  "sdk_blacklist_wp80_device_unique_id": true,
  "sdk_blacklist_waid": true,
  "sdk_blacklist_limit_ad_tracking": true,
  "sdk_blacklist_affinity_group": true,
  "sdk_whitelist_email": false,
  "sdk_whitelist_location": false,
  "sdk_blacklist_iad": false,
  "sdk_iad_retry_wait": "",
  "sdk_iad_attempts": "",
  "sdk_iad_wait": "",
  "sdk_send_id_updates": false,
  "sdk_override_adid": false,
  "disregard_organic_events": false,
  "whatif_parent": 0,
  "use_install_referrer_begin_time": false,
  "consent_region": "none",
  "consent_prompt_retry_interval": 2592000,
  "consent_prompt_id": "",
  "consent_partners": null,
  "events": [
    {
      "id": 462929867,
      "name": "_Click",
      "name_norm": "_click",
      "is_revenue": false,
      "is_active": true
    },
    {
      "id": 465655964,
      "name": "_SessionBegin",
      "name_norm": "_sessionbegin",
      "is_revenue": false,
      "is_active": true
    },
    {
      "id": 465655965,
      "name": "_Install",
      "name_norm": "_install",
      "custom_dimensions": [
        {
          "id": 305344146,
          "name": "receipt_status",
          "name_norm": "receipt_status",
          "is_active": true
        }
      ],
      "is_revenue": false,
      "is_active": true
    }
  ],
  "context": null,
  "app_store_info": {
    "publisher_id": "4344",
    "app_icon": "https://lh3.googleusercontent.com/ghHHtrtrf56-fhasJKHytrHGtuhHGffg677Fr",
    "coo": "US",
    "publisher_name": "MY PUB",
    "main_category_code": "GAME_ROLE_PLAYING",
    "monetization": "1",
    "platform": "gp",
    "app_name": "My best App",
    "release_date": "2015-10-31",
    "category_ids": [
      "GAME",
      "GAME_ROLE_PLAYING"
    ],
    "has_iap": true,
    "is_featured": false,
    "metrics_by_country": null,
    "downloads_last_7_days_actual": "11843",
    "revenue_last_7_days_actual": "118809",
    "downloads_last_30_days_actual": "66775",
    "revenue_last_30_days_actual": "668637",
    "dau_last_30_days_actual": "71360",
    "mau_last_30_days_actual": "389590",
    "downloads_last_cal_month_actual": "96299",
    "revenue_last_cal_month_actual": "816910",
    "downloads_last_quarter_actual": "330809",
    "revenue_last_quarter_actual": "1977757",
    "downloads_last_cal_year_actual": "1016426",
    "revenue_last_cal_year_actual": "8719827",
    "downloads_ytd_actual": "137379",
    "revenue_ytd_actual": "1244403",
    "downloads_since_tracked_actual": "3348938",
    "revenue_since_tracked_actual": "17734725"
  }
}

Verify App Exists

This API is used to check if an app exists by providing the API the numerical app ID (1234 in this case) to look up.

Sample Request:

>HEAD /apps/1234 HTTP/1.1
Host: api.kochava.com
Authentication-Key: <MyAccountApiKey>

Sample Response:

>HTTP/1.1 200 OK

Create New App

This API is used to create a new app under your account by providing it a JSON definition of the app.

Currently Accepted Platform — SDK Integration Type Values:

sdk_integrations_key platform_key
adobe-air android
androidinstantapp
ios
iosappclip
kindle
classic-desktop windows
corona android
androidinstantapp
ios
iosappclip
kindle
flutter android
androidinstantapp
ios
iosappclip
native-android android
androidinstantapp
androidtv
kindle
oculusgo
samsunggearvr
native-ios ios
iosappclip
tvos
native-web web
phonegap android
androidinstantapp
ios
iosappclip
kindle
react-native android
androidinstantapp
ios
iosappclip
kindle
windows
s2s android
androidtv
chromecast
daydream
htcvive
ios
kindle
linux
macosx
nintendoswitch
nintendowiiu
oculusgo
oculusrift
playstation
roku
samsunggearvr
tizenos
tvos
viziosmartcastos
web
webgl
webos
windows
windowsxbox
unity android
androidinstantapp
htcvive
ios
iosappclip
kindle
linux
macosx
oculusrift
webgl
windows
win32 htcvive
oculusrift
winrt windows
windowsxbox
xamarin android
androidinstantapp
ios
iosappclip
kindle
windows

NOTE: The name of the app has to be unique across the entire Kochava system.

Sample Request:

POST: https://apps.api.kochava.com/app
Header: Authentication-Key: {MyUserAPIKey}

Sample Body:

{
  "account_id": account id,
  "name": "Conversions Demo",
  "platform": "android",
  "integration_type": "native-android",
  "traffic_processing": "full",
  "session_tracking": "full",
  "ibeacon_enabled": true
}

Sample Response:

>{
  "account_id": 5,
  "link_type": "advertiser",
  "id": 17090,
  "guid": "koconversions-demo-3ixhy8",
  "package_code": "android5",
  "path": "/koconversions-demo-3ixhy8/",
  "cluster_analytics": 0,
  "cluster_control": 17,
  "registered": "2016-06-18T00:35:31.845000202-07:00",
  "updated": "2016-06-18T00:35:31.845000802-07:00",
  "session_tracking": "full",
  "traffic_processing": "active",
  "ibeacon_enabled": true,
  "deleted": false,
  "push_enabled": false,
  "sms_enabled": false,
  "app_universal_link_enabled": false,
  "fraud_blacklist": false,
  "name": "Conversions Demo",
  "platform": "android",
  "sku": "",
  "integration_type": "native-android",
  "facebook_app_id": "",
  "kochava_app_url": "",
  "app_store_id": "",
  "twilio_account_sid": "",
  "twilio_basic_auth": "",
  "twilio_from_number": "",
  "aws_region": "",
  "aws_bucket": "",
  "aws_access_key": "",
  "aws_secret_key": "",
  "request_time_pref": "",
  "overwrite_origination_ip": false,
  "use_short_version_string": false,
  "api_access_enabled": true,
  "currency_processing": false,
  "sdk_blacklist_mac": true,
  "sdk_blacklist_odin": true,
  "sdk_blacklist_open_udid": true,
  "sdk_blacklist_fb_attribution_id": true,
  "sdk_blacklist_android_id": true,
  "sdk_blacklist_imei": true,
  "sdk_blacklist_prefer_adid_only": true,
  "sdk_blacklist_adid": true,
  "sdk_blacklist_idfv": true,
  "sdk_blacklist_bssid": true,
  "sdk_blacklist_ssid": true,
  "sdk_blacklist_wp80_device_unique_id": true,
  "sdk_blacklist_waid": true,
  "sdk_blacklist_limit_ad_tracking": true,
  "sdk_blacklist_affinity_group": true,
  "sdk_whitelist_email": false,
  "sdk_whitelist_location": false,
  "sdk_blacklist_iad": false,
  "sdk_iad_retry_wait": "",
  "sdk_iad_attempts": "",
  "sdk_iad_wait": "",
  "sdk_send_id_updates": false,
  "sdk_override_adid": false,
  "disregard_organic_events": false,
  "whatif_parent": 0,
  "use_install_referrer_begin_time": false,
  "consent_region": "none",
  "consent_prompt_retry_interval": 2592000,
  "consent_prompt_id": "",
  "consent_partners": null,
  "context": {
    "api_key": "A66AAE85-371F-46B8-8CDE-D5B9D5B0240B",
    "api_key_account": 5,
    "api_key_generated": null,
    "api_key_kind": "sprinkler",
    "api_key_user": 0,
    "request_from": "192.168.137.1:52110",
    "request_id": "000045f8005764f9c30000000000000004"
  }
}

Updating Existing App

This API is used to update an existing app under your account by providing it a JSON definition of the app.

Sample Request:

PATCH: https://apps.api.kochava.com/app/app_id
Header: Authentication-Key: {MyUserAPIKey}

Sample Body:

>{
  "account_id": 5,
  "id": 17999,
  "guid": "koconversions-demo-3ixhy8",
  "package_code": "android5",
  "path": "/koconversions-demo-3ixhy8/",
  "cluster_analytics": 0,
  "cluster_control": 17,
  "registered": "2016-06-18T07:35:32Z",
  "updated": "2016-06-18T07:35:32Z",
  "session_tracking": "full",
  "traffic_processing": "active",
  "ibeacon_enabled": true,
  "deleted": false,
  "push_enabled": false,
  "app_universal_link_enabled": false,
  "fraud_blacklist": false,
  "name": "Conversions Demo",
  "platform": "android",
  "sku": "",
  "integration_type": "native-android",
  "facebook_app_id": "",
  "kochava_app_url": "",
  "app_store_id": "",
  "twilio_account_sid": "",
  "twilio_basic_auth": "",
  "twilio_from_number": "",
  "aws_region": "",
  "aws_bucket": "",
  "aws_access_key": "",
  "aws_secret_key": "",
  "request_time_pref": "",
  "overwrite_origination_ip": false,
  "use_short_version_string": false,
  "api_access_enabled": true,
  "currency_processing": false,
  "sdk_blacklist_mac": true,
  "sdk_blacklist_odin": true,
  "sdk_blacklist_open_udid": true,
  "sdk_blacklist_fb_attribution_id": true,
  "sdk_blacklist_android_id": true,
  "sdk_blacklist_imei": true,
  "sdk_blacklist_prefer_adid_only": true,
  "sdk_blacklist_adid": true,
  "sdk_blacklist_idfv": true,
  "sdk_blacklist_bssid": true,
  "sdk_blacklist_ssid": true,
  "sdk_blacklist_wp80_device_unique_id": true,
  "sdk_blacklist_waid": true,
  "sdk_blacklist_limit_ad_tracking": true,
  "sdk_blacklist_affinity_group": true,
  "sdk_whitelist_email": false,
  "sdk_whitelist_location": false,
  "sdk_whitelist_location": false,
  "sdk_blacklist_iad": false,
  "sdk_iad_retry_wait": "",
  "sdk_iad_attempts": "",
  "sdk_iad_wait": "",
  "sdk_send_id_updates": false,
  "sdk_override_adid": false,
  "disregard_organic_events": false,
  "whatif_parent": 0,
  "use_install_referrer_begin_time": false,
  "consent_region": "none",
  "consent_prompt_retry_interval": 2592000,
  "consent_prompt_id": "",
  "consent_partners": null,
  "context": null
  "events": [
    {
      "id": 462929867,
      "name": "_Click",
      "name_norm": "_click",
      "is_revenue": false,
      "is_active": true
    },
    {
      "id": 465655964,
      "name": "_SessionBegin",
      "name_norm": "_sessionbegin",
      "is_revenue": false,
      "is_active": true
    },
    {
      "id": 465655965,
      "name": "_Install",
      "name_norm": "_install",
      "custom_dimensions": [
        {
          "id": 305344146,
          "name": "receipt_status",
          "name_norm": "receipt_status",
          "is_active": true
        }
      ],
      "is_revenue": false,
      "is_active": true
    }
  ],
  "context": null
}
Updated on December 27, 2024

Was this article helpful?

Yes No