API Documentation

Update Tracker Asset

Suggest Edits

📘

PATCH https://api.kayzen.io/v1/tracker_assets/:id

{  
  "name": "Test tracker",
  "click_url": "http://click1.adv.com?af_c_id={CAMPAIGN_ID}",
  "impression_urls": [
        "http://impression.appsflyer.com/com.app_bundle?af_c_id={CAMPAIGN_ID}",
        "http://imp2.adv.com/com.app_bundle?af_c_id={CAMPAIGN_ID}"
  ],
  "s2s_url": "http://s2s_url.adv.com/com/app_bundle?af_c_id={CAMPAIGN_ID}",
  "video_start_tracking_url": "http://start.adv.com",
  "video_first_quartile_tracking_url": "http://first.adv.com",
  "video_midpoint_tracking_url": "http://mid.adv.com",
  "video_third_quartile_tracking_url": "http://third.adv.com",
  "video_complete_tracking_url": "http://complete.adv.com",
  "video_click_tracking_url": "http://tracking.adv.com"
}

Use this API to update a tracker asset. Don't send a parameter if you want to keep it's current value

See below for supported parameters

FieldParamRequired/ OptionalDescription
namestringrequiredName, must not be empty string or null if you send it; omit this parameter to keep it as it is
click_urlstring/nullrequiredClick URL, must not be empty string or null if you send it; omit this parameter to keep it as it is
impression_urlsarray of stringsoptionalImpression URLs
s2s_urlstringoptionalS2S URL
video_start_tracking_urlstringoptionalAdvanced Video Tracking: Start URL
video_first_quartile_tracking_urlstringoptionalAdvanced Video Tracking: First Quartile URL
video_midpoint_tracking_urlstringoptionalAdvanced Video Tracking: Midpoint URL
video_third_quartile_tracking_urlstringoptionalAdvanced Video Tracking: Third Quartile URL
video_complete_tracking_urlstringoptionalAdvanced Video Tracking: Complete URL
video_click_tracking_urlstringoptionalAdvanced Video Tracking: Click URL
curl -X PATCH \
'https://api.kayzen.io/v1/tracker_assets/1234' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN'
-d '{  
  "name": "Test tracker",
  "click_url": "http://click1.adv.com?af_c_id={CAMPAIGN_ID}",
  "impression_urls": [
        "http://impression.appsflyer.com/com.app_bundle?af_c_id={CAMPAIGN_ID}",
        "http://imp2.adv.com/com.app_bundle?af_c_id={CAMPAIGN_ID}"
  ],
  "s2s_url": "http://s2s_url.adv.com/com/app_bundle?af_c_id={CAMPAIGN_ID}",
  "video_start_tracking_url": "http://start.adv.com",
  "video_first_quartile_tracking_url": "http://first.adv.com",
  "video_midpoint_tracking_url": "http://mid.adv.com",
  "video_third_quartile_tracking_url": "http://third.adv.com",
  "video_complete_tracking_url": "http://complete.adv.com",
  "video_click_tracking_url": "http://tracking.adv.com"
}'

Successful response will have 200 status and following body:

{  
  "id": 1234,
  "name": "Test tracker",
  "updated_at": "2021-12-16T23:53:02.000Z",
  "click_url": "http://click1.adv.com?af_c_id={CAMPAIGN_ID}",
  "impression_urls": [
        "http://impression.appsflyer.com/com.app_bundle?af_c_id={CAMPAIGN_ID}",
        "http://imp2.adv.com/com.app_bundle?af_c_id={CAMPAIGN_ID}"
  ],
  "s2s_url": "http://s2s_url.adv.com/com/app_bundle?af_c_id={CAMPAIGN_ID}",
  "mobile_object": {
    "ad_domain": "http://www.appname.com/",
        "icon_url": "https://lh3.googleusercontent.com/bYtqbOcTYOlgc6gqZ2rwb8lptHuwlNE75zYJu6Bn076-hTmvd96HH-6v7S0YUAAJXoJN=s180",
        "id": 666,
        "name": "App Name",
        "os": {
      "id": 11, 
      "name": "Android"
    },
        "os_id": 11,
        "rating": "4.32",
        "store_app_id": "com.appname",
        "store_app_url": "https://play.google.com/store/apps/details?id=com.whatsapp",
        "type": "AppObject"
  },
  "video_start_tracking_url": "http://start.adv.com",
  "video_first_quartile_tracking_url": "http://first.adv.com",
  "video_midpoint_tracking_url": "http://mid.adv.com",
  "video_third_quartile_tracking_url": "http://third.adv.com",
  "video_complete_tracking_url": "http://complete.adv.com",
  "video_click_tracking_url": "http://tracking.adv.com"
}

Unsuccessful response will 422 status and the body will have error details in JSON format

Updated about 1 year ago