Support Home > Analytics, Reports & API > Premium Publisher API Campaign Management

Premium Publisher API Campaign Management

The Kochava platform provides extensive tools to track everything from impressions through post-install events for connected devices. The Campaign Management API Integration provides the programmatic tools to create and maintain campaigns, segments and trackers.

Get Campaigns List

This API provides the ability to retrieve the entire list of campaigns from the numerical App ID provided in the URL.

 

ParametersDescriptionFormat
app_idApp_id that the campaign is associated with.

Example: 123

String
statsWhether to include number_of_trackers and number_of_tiers.

Example: true

Boolean

 

Sample Request:

GET: https://campaign.api.kochava.com/campaign/{app_id}?stats={stats}
Authentication Key: {MyUserAPIKey}

 

Sample Response:

[
  {
    "id": "11133239913",
    "app_id": "11193",
    "type": "type_url_forward",
    "source": "v1up",
    "name": "censoring test",
    "destination_url": "http://google.com",
    "date_created": 1476912340,
    "date_start": 0,
    "date_end": 0,
    "date_track_outside_range": false,
    "budget_daily": 0,
    "budget_weekly": 0,
    "budget_max": 0,
    "target_clicks": 0,
    "target_installs": 0,
    "meta": "",
    "legacy_io_guid": "",
    "smart_link_id": "",
    "what_if_parent_campaign_id": ""
  },
  {
    "id": "11133165431",
    "app_id": "11193",
    "type": "type_url_forward",
    "source": "web",
    "name": "Facebook 02.16.2016",
    "destination_url": "",
    "date_created": 1455565374,
    "date_start": 0,
    "date_end": 0,
    "date_track_outside_range": true,
    "budget_daily": 0,
    "budget_weekly": 0,
    "budget_max": 0,
    "target_clicks": 0,
    "target_installs": 0,
    "meta": "",
    "legacy_io_guid": "",
    "smart_link_id": "72",
    "what_if_parent_campaign_id": ""
  },
  {
    "id": "11133223385",
    "app_id": "11193",
    "type": "type_url_forward",
    "source": "web",
    "name": "new sl",
    "destination_url": "",
    "date_created": 1469462822,
    "date_start": 0,
    "date_end": 0,
    "date_track_outside_range": true,
    "budget_daily": 0,
    "budget_weekly": 0,
    "budget_max": 0,
    "target_clicks": 0,
    "target_installs": 0,
    "meta": "",
    "legacy_io_guid": "",
    "smart_link_id": "1119",
    "what_if_parent_campaign_id": ""
  },
  {
    "id": "11133187461",
    "app_id": "11193",
    "type": "type_url_forward",
    "source": "v1up",
    "name": "Re-Direct Test \"",
    "destination_url": "http://",
    "date_created": 1456273410,
    "date_start": 0,
    "date_end": 0,
    "date_track_outside_range": false,
    "budget_daily": 0,
    "budget_weekly": 0,
    "budget_max": 0,
    "target_clicks": 0,
    "target_installs": 0,
    "meta": "",
    "legacy_io_guid": "",
    "smart_link_id": "",
    "what_if_parent_campaign_id": ""
  }
]

Create a Campaign

This API is used to create a new campaign by providing a JSON definition of the campaign.

 

ParametersDescriptionFormat
app_idApp_id that the campaign is associated with.

Example: 123

String

 

Sample Request:

Post: https://campaign.api.kochava.com/campaign/{app_id}
Authentication-Key: {MyUserAPIKey}
Body:{
  "name": "this campaign",
  "date_end": 1490727343,
  "date_start": 1490727343,
  "destination_url": "http://",
  "source": "api"
}

 

Sample Response:

{
  "id": "2",
  "app_id": "14393",
  "type": "type_url_forward",
  "source": "api",
  "name": "this campaign",
  "destination_url": "http://",
  "date_created": 1493327428,
  "date_start": 1490727343,
  "date_end": 1490727343,
  "date_track_outside_range": false,
  "budget_daily": 0,
  "budget_weekly": 0,
  "budget_max": 0,
  "target_clicks": 0,
  "target_installs": 0,
  "meta": "",
  "legacy_io_guid": "",
  "smart_link_id": null,
  "what_if_parent_campaign_id": null
}

Update a Campaign

This API is used to update an existing campaign by providing a JSON definition of the campaign with the modifications. If the campaign is successfully updated an HTTP 200 code and response, as shown below, is returned.

 

ParametersDescriptionFormat
app_idApp_id that the campaign is associated with.

Example: 123

String

 

Sample Request:

Post: https://campaign.api.kochava.com/campaign/{app_id}
Authentication-Key: {MyUserAPIKey}
Body:{
  "id": "2",
  "name": "new campaign name"
}

 

Sample Response:

{
  "id": "2",
  "app_id": "14393",
  "type": "type_url_forward",
  "source": "api",
  "name": "new campaign name",
  "destination_url": "http://",
  "date_created": 1493327428,
  "date_start": 1490727343,
  "date_end": 1490727343,
  "date_track_outside_range": false,
  "budget_daily": 0,
  "budget_weekly": 0,
  "budget_max": 0,
  "target_clicks": 0,
  "target_installs": 0,
  "meta": "",
  "legacy_io_guid": "",
  "smart_link_id": null,
  "what_if_parent_campaign_id": null
}

Get Campaign by ID

This API provides the ability to retrieve a single campaign for the numerical Campaign ID provided in the URL.

 

ParametersDescriptionFormat
app_idApp_id that the campaign is associated with.

Example: 123

String
campaign_idThe campaign associated with this campaign_id are returned.

Example: 123

Boolean

 

Sample Request:

Get: https://campaign.api.kochava.com/campaign/{app_id}/{campaign_id}
Authentication-Key: {MyUserAPIKey}

 

Sample Response:

{
  "id": "2",
  "app_id": "14393",
  "type": "type_url_forward",
  "source": "api",
  "name": "new campaign name",
  "destination_url": "http://",
  "date_created": 1493327428,
  "date_start": 1490727343,
  "date_end": 1490727343,
  "date_track_outside_range": false,
  "budget_daily": 0,
  "budget_weekly": 0,
  "budget_max": 0,
  "target_clicks": 0,
  "target_installs": 0,
  "meta": "",
  "legacy_io_guid": "",
  "smart_link_id": null,
  "what_if_parent_campaign_id": null
}

Get Segments

This API provides the ability to retrieve the segments for the numerical Campaign ID provided in the URL.

 

ParametersDescriptionFormat
campaign_idSegments associated with this campaign_id are returned.

Example: 123

String

 

Sample Request:

Get: https://campaign.api.kochava.com/tier/{campaign_id}
Authentication-Key: {MyUserAPIKey}

 

Sample Response:

[
  {
    "id": "13033251866",
    "app_id": "14393",
    "campaign_id": "13033239913",
    "source": "web",
    "name": "Default Segment",
    "target_geo": "",
    "date_created": 1476912355,
    "what_if_parent_tier_id": ""
  }
]

Create a Segment

This API is used to create a new segment by providing a JSON definition of the segment.

 

ParametersDescriptionFormat
campaign_idSegment will be created within the designated campaign_id.

Example: 123

String

 

Sample Request:

Post: https://campaign.api.kochava.com/tier/{campaign_id}
Authentication-Key: {MyUserAPIKey}
Body:{
  "name": "new tier",
  "source": "web"
}

 

Sample Response:

{
  "id": "2",
  "app_id": "14393",
  "campaign_id": "1",
  "source": "web",
  "name": "new tier",
  "target_geo": "",
  "date_created": 1493328053,
  "what_if_parent_tier_id": null
}

Update a Segment

This API is used to update an existing segment by providing a JSON definition of the segment with the modifications. If the segment is successfully updated an HTTP 200 code and response, as shown below, is returned.

 

ParametersDescriptionFormat
campaign_idSegment will be updated within the designated campaign_id.

Example: 123

String

 

Sample Request:

Post: https://campaign.api.kochava.com/tier/{campaign_id}
Authentication-Key: {MyUserAPIKey}
Body:{
    "id": "2"
    "name":"new name"
}

 

Sample Response:

{
  "id": "2",
  "app_id": "14393",
  "campaign_id": "1",
  "source": "web",
  "name": "new name",
  "target_geo": "",
  "date_created": 1493328053,
  "what_if_parent_tier_id": null
}

Get Segment by ID

This API provides the ability to retrieve a single segment for the numerical Segment ID provided in the URL.

 

ParametersDescriptionFormat
campaign_idDesignated campaign which contains the desired segment.

Example: 123

String
tier_idSegment will be returned with the designated tier_id.

Example: 123

String

 

Sample Request:

Get: https://campaign.api.kochava.com/tier/{campaign_id}/{tier_id}
Authentication-Key: {MyUserAPIKey}

 

Sample Response:

{
  "id": "2",
  "app_id": "14393",
  "campaign_id": "1",
  "source": "web",
  "name": "new name",
  "target_geo": "",
  "date_created": 1493328053,
  "what_if_parent_tier_id": null
}

Get Trackers

This API provides the ability to retrieve the entire list of trackers for the numerical App ID provided in the URL.

 

ParametersDescriptionFormat
app_idApp_id that the trackers are associated with.

Example: 123

String
tracker_idsComma separated list of trackers to return.

Example: 123,456

String
editablewhether to just include non-SAN, non-Smartlink trackers.

Example: true

Boolean
network_nameInclude only results from this network.

Example: Applovin - iOS

String
campaign_nameInclude only results from this campaign.

Example: Demo Campaign

String
tier_nameInclude only results from this tier.

Example: Default Tier

String
network_pricingInclude only results with this price type.

Example: cpi

String
typeInclude only results of this type.

Example: type_url_forward

String
network_name_notExclude results from this.

Example: Applovin - iOS

String
campaign_name_notExclude results from this campaign.

Example: Demo Campaign

String
tier_name_notExclude results from this tier.

Example: Default Tier

String
network_pricing_notExclude results with this price type.

Example: cpc

String
type_notExclude results with this type.

Example: type_url_forward

String
traffic_verificationInclude or exclude trackers with traffic verification rules.

Example: true

String
tracker_overridesInclude or exclude trackers with override rules.

Example: true

String
campaign_idsInclude these campaign ids in the results.

Example: 1,2

String
tier_idsInclude these tier ids in the results.

Example: 1,2

 

Sample Request:

Get: https://campaign.api.kochava.com/tracker/{app_id}?ids={tracker_ids}&editable={editable}&network_name={network_name}&network_name_not={network_name_not}&campaign_name={campaign_name}&campaign_name_not={campaign_name_not}&tier_name={tier_name}&tier_name_not={tier_name_not}&network_pricing={network_pricing}&network_pricing_not={network_pricing_not}&type={type}&type_not={type_not}&traffic_verification={traffic_verification}&tracker_overrides={tracker_overrides}
Authentication-Key: {MyUserAPIKey}
Accept-Encoding: application/json (application/gzip)

 

Sample Response:

[
  {
    "id": "13033249379",
    "tier_id": "13033170351",
    "campaign_id": "13033165431",
    "app_id": "14393",
    "date_created": "2016-07-25T09:08:01-07:00",
    "source": "web",
    "guid": "kojoseph-android56a2a4e6b9e6f6fef310549fc3",
    "name": "GooglePlay",
    "type": "type_url_forward",
    "click_tracking_url": "https://control.kochava.com/v1/cpi/click?campaign_id=kojoseph-android56a2a4e6b9e6f6fef310549fc3&network_id=3881&site_id=none&device_id=device_id",
    "imp_tracking_url": "https://imp.control.kochava.com/track/impression?campaign_id=kojoseph-android56a2a4e6b9e6f6fef310549fc3&network_id=3881&site_id=none&device_id=device_id",
    "destination_url": "https://play.google.com/store/apps/details?id=uk.co.hellogames.jdtouch",
    "destination_url_reengagement": "",
    "network_id": "3881",
    "network_pricing": "cpc",
    "network_price": "0.00",
    "budget_daily": "0.00",
    "budget_weekly": "0.00",
    "budget_max": "0.00",
    "rtb_id": "",
    "rtb_definitions": "{}",
    "meta": "",
    "legacy_campaign_id": "6fef310549fc3",
    "legacy_post_id": "30",
    "perm_publisher_allow_view": "1",
    "is_active": "1",
    "creative_ids": [],
    "click_url_custom_params": [],
    "destination_data": {},
    "rtb_update_status": "",
    "rtb_update_response": null,
    "rtb_update_pid": null,
    "s2s_destination": null,
    "postback_url": null,
    "verification_rules": null,
    "smart_link_id": null,
    "what_if_parent_tracker_id": null,
    "network_name": "SmartLinks",
    "network_is_self_attributing": false,
    "campaign_name": "Facebook 02.16.2016",
    "tier_name": "Segment Smartlink 14393",
    "app_guid": "kotestapp12345",
    "agency_tracker_id": null,
    "twitter_event_guid": "FCAF8281-387F-4092-8156-88E3DBA60842",
    "google_android_postback_url": "https://control.kochava.com/v1/cpi/network_specific/90_startup?campaign_id=kojoseph-android56a2a4e6b9e6f&device_id={adid}&device_id_type=adid&lat={lat}&click_url={click_url}&click_timestamp={click_ts}&trv_campaign={campaign_id}&video_id={video_id}",
    "google_ios_postback_url": "https://control.kochava.com/v1/cpi/network_specific/351_startup?campaign_id=kojoseph-android56a2a4e6b9e6f&device_id={md5_advertising_id}&device_id_type=idfa&device_hash_method=md5&device_id_is_hashed=true&lat={lat}&click_url={click_url}&click_timestamp={click_ts}&trv_campaign={campaign_id}&video_id={video_id}"
  },
  {
    "id": "13033271906",
    "tier_id": "13033192401",
    "campaign_id": "13033187461",
    "app_id": "14393",
    "date_created": "2016-02-23T16:24:15-08:00",
    "source": "web",
    "guid": "kojoseph-android56a2a4e6b9e6f144bda33e7bc5",
    "name": "SL Re_direct Test2",
    "type": "type_url_forward",
    "click_tracking_url": "https://control.kochava.com/v1/cpi/click?campaign_id=kojoseph-android56a2a4e6b9e6f6fef310549fc3&network_id=3881&site_id=none&device_id=device_id",
    "imp_tracking_url": "https://imp.control.kochava.com/track/impression?campaign_id=kojoseph-android56a2a4e6b9e6f6fef310549fc3&network_id=3881&site_id=none&device_id=device_id",
    "destination_url": "http://smart.link/56c22a3d7a56f?site_id=99&custom_1=99",
    "destination_url_reengagement": "",
    "network_id": "1",
    "network_pricing": "cpc",
    "network_price": "0.00",
    "budget_daily": "0.00",
    "budget_weekly": "0.00",
    "budget_max": "0.00",
    "rtb_id": null,
    "rtb_definitions": null,
    "meta": "{}",
    "legacy_campaign_id": "144bda33e7bc5",
    "legacy_post_id": "6",
    "perm_publisher_allow_view": "1",
    "is_active": "0",
    "creative_ids": [],
    "click_url_custom_params": [
      {
        "key": "tom",
        "value": "leland"
      },
      {
        "key": "bllop",
        "value": "bleep"
      }
    ],
    "destination_data": {
      "type": "custom",
      "typeObj": "{\"name\":\"Custom\",\"active\":true}"
    },
    "rtb_update_status": "",
    "rtb_update_response": null,
    "rtb_update_pid": null,
    "s2s_destination": "",
    "postback_url": "",
    "verification_rules": null,
    "smart_link_id": null,
    "what_if_parent_tracker_id": null,
    "network_name": "Mobile Posse",
    "network_is_self_attributing": false,
    "campaign_name": "Re-Direct Test",
    "tier_name": "Default Segment",
    "app_guid": "kotestapp12345",
    "agency_tracker_id": null,
    "twttter_event_guid": "5C0356B4-814C-49FA-92E0-6EEEBFA7D632",
    "google_android_postback_url": "https://control.kochava.com/v1/cpi/network_specific/90_startup?campaign_id=kojoseph-android56a2a4e6b9e6f&device_id={adid}&device_id_type=adid&lat={lat}&click_url={click_url}&click_timestamp={click_ts}&trv_campaign={campaign_id}&video_id={video_id}",
    "google_ios_postback_url": "https://control.kochava.com/v1/cpi/network_specific/351_startup?campaign_id=kojoseph-android56a2a4e6b9e6f&device_id={md5_advertising_id}&device_id_type=idfa&device_hash_method=md5&device_id_is_hashed=true&lat={lat}&click_url={click_url}&click_timestamp={click_ts}&trv_campaign={campaign_id}&video_id={video_id}"
  }
]

Update Trackers

This API is used to update an existing tracker by providing a JSON definition of the tracker with modifications. If the tracker is successfully updated an HTTP 200 code and response, as shown below, is returned.

 

ParametersDescriptionFormat
app_idApp_id that the trackers are associated with.

Example: 123

String

 

Sample Request:

Post: https://campaign.api.kochava.com/tracker/{app_id}
Content-Type: application/json; charset=utf-8
Authentication-Key: {MyUserAPIKey}
Body: {
  "id": "13033249379",
  "name": "New tracker name"
}

 

Sample Response:

{
  "id": "1",
  "tier_id": "1",
  "campaign_id": "1",
  "app_id": "14393",
  "date_created": "2017-04-27T18:57:17.578263758Z",
  "source": "web",
  "guid": "kojoseph-android56a2a4e6b9e6fe8b7504849dbf",
  "name": "Web app tracker - 1",
  "type": "type_url_forward",
  "click_tracking_url": "",
  "imp_tracking_url": "",
  "destination_url": "http://",
  "destination_url_reengagement": "",
  "network_id": "1",
  "network_pricing": "cpi",
  "network_price": 0,
  "budget_daily": 0,
  "budget_weekly": 0,
  "budget_max": 0,
  "rtb_id": null,
  "rtb_definition": null,
  "meta": "",
  "legacy_campaign_id": "e8b7504849dbf",
  "legacy_post_id": "1",
  "perm_publisher_allow_view": false,
  "is_active": true,
  "creative_ids": null,
  "click_url_custom_params": [],
  "destination_data": {
    "type": "",
    "typeObj": "{}"
  },
  "rtb_update_status": "",
  "rtb_update_response": null,
  "rtb_update_pid": null,
  "s2s_destination": null,
  "postback_url": null,
  "verification_rules": null,
  "smart_link_id": null,
  "what_if_parent_tracker_id": null,
  "network_name": "",
  "network_is_self_attributing": false,
  "network_supports_impressions": false,
  "campaign_name": "",
  "tier_name": "",
  "events": null,
  "app_guid": "kotestapp12345",
  "agency_tracker_id": null,
  "twttter_event_guid": "B0828B49-14A7-4FEF-A9C4-C7749358392F",
  "google_android_postback_url": "https://control.kochava.com/v1/cpi/network_specific/90_startup?campaign_id=kojoseph-android56a2a4e6b9e6f&device_id={adid}&device_id_type=adid&lat={lat}&click_url={click_url}&click_timestamp={click_ts}&trv_campaign={campaign_id}&video_id={video_id}",
  "google_ios_postback_url": "https://control.kochava.com/v1/cpi/network_specific/351_startup?campaign_id=kojoseph-android56a2a4e6b9e6f&device_id={md5_advertising_id}&device_id_type=idfa&device_hash_method=md5&device_id_is_hashed=true&lat={lat}&click_url={click_url}&click_timestamp={click_ts}&trv_campaign={campaign_id}&video_id={video_id}"
}

Delete a Tracker

This API is used to delete an existing tracker by providing the numerical Tracker ID. If the tracker is deleted an HTTP 200 response will be returned, otherwise another HTTP code and message detailing the error will be returned.

 

ParametersDescriptionFormat
app_idApp_id that the trackers are associated with.

Example: 123

String
tracker_idComma seperated list of trackers to return.

Example: 123

String

 

Sample Request:

Delete: https://campaign.api.kochava.com/tracker/{app_id}/delete/{tracker_id}
Content-Type: application/json; charset=utf-8
Authentication-Key: {MyUserAPIKey}

 

Sample Response:

{
  "success": "Tracker deleted"
}

Create a Tracker

This API is used to create a new tracker by providing a JSON definition of the tracker.

 

ParametersDescriptionFormat
app_idApp_id that the tracker will be associated with.

Example: 123

String

 

Sample Request:

Post: https://campaign.api.kochava.com/tracker/{app_id}/create
Content-Type: application/json; charset=utf-8
Authentication-Key: {MyUserAPIKey}
Body: {
  "name": "Web app tracker - 1",
  "type": "type_url_forward",
  "network_id": "1",
  "destination_url": "http://a-great-dest.com",
  "destination_url_reengagement": "",
  "network_pricing": "cpi",
  "network_price": 0,
  "perm_publisher_allow_view": false,
  "click_url_custom_params": [],
  "tier_id": "1",
  "campaign_id": "1",
  "agency_network_id": "0",
  "destination_data": {
    "type": "",
    "typeObj": "{}"
  },
  "events": [
    "cool",
    "events"
  ]
}

 

Sample Response:

{
  "id": "1",
  "tier_id": "1",
  "campaign_id": "1",
  "app_id": "14393",
  "date_created": "2017-04-27T18:57:17.578263758Z",
  "source": "web",
  "guid": "kojoseph-android56a2a4e6b9e6fe8b7504849dbf",
  "name": "Web app tracker - 1",
  "type": "type_url_forward",
  "click_tracking_url": "",
  "imp_tracking_url": "",
  "destination_url": "http://",
  "destination_url_reengagement": "",
  "network_id": "1",
  "network_pricing": "cpi",
  "network_price": 0,
  "budget_daily": 0,
  "budget_weekly": 0,
  "budget_max": 0,
  "rtb_id": null,
  "rtb_definition": null,
  "meta": "",
  "legacy_campaign_id": "e8b7504849dbf",
  "legacy_post_id": "1",
  "perm_publisher_allow_view": false,
  "is_active": true,
  "creative_ids": null,
  "click_url_custom_params": [],
  "destination_data": {
    "type": "",
    "typeObj": "{}"
  },
  "rtb_update_status": "",
  "rtb_update_response": null,
  "rtb_update_pid": null,
  "s2s_destination": null,
  "postback_url": null,
  "verification_rules": null,
  "smart_link_id": null,
  "what_if_parent_tracker_id": null,
  "network_name": "",
  "network_is_self_attributing": false,
  "network_supports_impressions": false,
  "campaign_name": "",
  "tier_name": "",
  "events": null,
  "app_guid": "kotestapp12345",
  "agency_tracker_id": null,
  "twttter_event_guid": "B0828B49-14A7-4FEF-A9C4-C7749358392F",
  "google_android_postback_url": "https://control.kochava.com/v1/cpi/network_specific/90_startup?campaign_id=kojoseph-android56a2a4e6b9e6f&device_id={adid}&device_id_type=adid&lat={lat}&click_url={click_url}&click_timestamp={click_ts}&trv_campaign={campaign_id}&video_id={video_id}",
  "google_ios_postback_url": "https://control.kochava.com/v1/cpi/network_specific/351_startup?campaign_id=kojoseph-android56a2a4e6b9e6f&device_id={md5_advertising_id}&device_id_type=idfa&device_hash_method=md5&device_id_is_hashed=true&lat={lat}&click_url={click_url}&click_timestamp={click_ts}&trv_campaign={campaign_id}&video_id={video_id}"
}

Get Tracker Overrides

This API provides the ability to retrieve the tracker overrides for the numerical Override ID provided in the URL.

 

ParametersDescriptionFormat
tracker_idDesignated tracker which the tracker overrides will be returned.

Example: 123

String

 

Sample Request:

Get: https://campaign.api.kochava.com/tracker/override?id={tracker_id}
Authentication-Key: {MyUserAPIKey}

 

Sample Response:

{
  "success": true,
  "request_id": "05250401062NRTLCA0QM120319571",
  "tracker_overrides": {
    "device_id_lookback_window": {
      "name": "Device",
      "key": "device_id_lookback_window",
      "group": "click",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "enable_verification": {
      "name": "Enable Verification",
      "key": "enable_verification",
      "group": "general",
      "type": "toggle",
      "value": 1,
      "admin": 0
    },
    "fingerprint_lookback_window": {
      "name": "Fingerprint",
      "key": "fingerprint_lookback_window",
      "group": "click",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impression_lookback_device": {
      "name": "Device",
      "key": "impression_lookback_device",
      "group": "impression",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impression_lookback_fingerprint": {
      "name": "Fingerprint",
      "key": "impression_lookback_fingerprint",
      "group": "impression",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impression_lookback_ip": {
      "name": "IP",
      "key": "impression_lookback_ip",
      "group": "impression",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impression_lookback_partial_ip": {
      "name": "Partial IP",
      "key": "impression_lookback_partial_ip",
      "group": "impression",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impressions_disable_attribution": {
      "name": "Disable Impression Attribution",
      "key": "impressions_disable_attribution",
      "group": "impression",
      "type": "toggle",
      "value": 1,
      "admin": 0
    },
    "ip_lookback_window": {
      "name": "IP",
      "key": "ip_lookback_window",
      "group": "click",
      "type": "select",
      "value": 1,
      "admin": 0
    }
  }
}

Post Tracker Overrides

This API provides the ability to create tracker overrides for the numerical Tracker ID provided in the URL.

 

ParametersDescriptionFormat
tracker_idDesignated tracker which the tracker overrides will be created for.

Example: 123

String

 

Values Available for Input:

  • device_id_lookback_window
  • event_association_lookback
  • fingerprint_equalizer_lookback
  • fingerprint_lookback_window
  • impression_lookback_device
  • impression_lookback_fingerprint
  • impression_lookback_ip
  • impression_lookback_partial_ip
  • ip_lookback_window
  • enable_verification
  • impressions_disable_attribution

 

Sample Request:

Post: https://campaign.api.kochava.com/tracker/override?id={tracker_id}
Content-Type: text/plain; charset=utf-8
Authentication-Key: {MyUserAPIKey}
Body: {
  "tracker_overrides": {
    "device_id_lookback_window": {
      "name": "Device",
      "key": "device_id_lookback_window",
      "group": "click",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "enable_verification": {
      "name": "Enable Verification",
      "key": "enable_verification",
      "group": "general",
      "type": "toggle",
      "value": 1,
      "admin": 0
    },
    "fingerprint_lookback_window": {
      "name": "Fingerprint",
      "key": "fingerprint_lookback_window",
      "group": "click",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impression_lookback_device": {
      "name": "Device",
      "key": "impression_lookback_device",
      "group": "impression",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impression_lookback_fingerprint": {
      "name": "Fingerprint",
      "key": "impression_lookback_fingerprint",
      "group": "impression",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impression_lookback_ip": {
      "name": "IP",
      "key": "impression_lookback_ip",
      "group": "impression",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impression_lookback_partial_ip": {
      "name": "Partial IP",
      "key": "impression_lookback_partial_ip",
      "group": "impression",
      "type": "select",
      "value": 1,
      "admin": 0
    },
    "impressions_disable_attribution": {
      "name": "Disable Impression Attribution",
      "key": "impressions_disable_attribution",
      "group": "impression",
      "type": "toggle",
      "value": 1,
      "admin": 0
    },
    "ip_lookback_window": {
      "name": "IP",
      "key": "ip_lookback_window",
      "group": "click",
      "type": "select",
      "value": 1,
      "admin": 0
    }
  }
}

 

Sample Response:

{
  "success": true,
  "request_id": "0519233001FPLLNGZIEY162611664"
}

 
 

Last Modified: Feb 20, 2024 at 4:27 pm