Trackers
The various methods for Trackers are listed below:
List Trackers
Lists out all trackers available for a placement for a given campaign and media plan.
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
| mediaPlanId | string | Mandatory | path | ID of the media plan associated with a given user account |
| campaignId | string | Mandatory | path | ID of the Campaign for which Tags need to be generated |
Sample Request
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/trackers/:campaignId?filters=sites_siteId=164830,sites_placements_placementId=db84237Sample Response
xxxxxxxxxx{ "mediaPlanId": 56354, "mediaPlanName": "twelve-bulk-tag", "sites": [ { "id": 164830, "placements": [ { "bannerImpressionInTagScriptTrackers": [ "xyz.com" ], "bannerImpressionOutTagScriptTrackers": [ "xyz.com" ], "bannerImpressionOutTagTrackers": [ "xyz.com" ], "bannerImpressionTrackers": [ "xyz.com" ], "creativeLoadEventTracker": [ "xyz.com" ], "fiftyPercentVideoViewedTracker": [ "xyz.com" ], "hundredPercentVideoViewedTracker": [ "xyz.com" ], "inStreamImpressionTrackers": [ "xyz.com" ], "inStreamSkipAdTracker": [ "xyz.com" ], "mobileBannerClickTracker": [ "xyz.com" ], "mobileImpressionClickInTagScriptTrackers": [ "xyz.com" ], "mobileImpressionClickOutTagScriptTrackers": [ "xyz.com" ], "mobileImpressionClickOutTagTrackers": [ "xyz.com" ], "mobileImpressionClickTrackers": [ "xyz.com" ], "muteVideoViewedTracker": [ "xyz.com" ], "placementId": "db84237", "placementName": "pn1", "primaryClickTracker": [ "xyz.com" ], "secondaryClickTrackers": [ "xyz.com", "xyz.com" ], "seventyFivePercentVideoViewedTracker": [ "xyz.com" ], "twentyFivePercentVideoViewedTracker": [ "xyz.com" ], "unmuteVideoViewedTracker": [ "xyz.com" ], "videoStartViewedTracker": [ "xyz.com" ] } ], "siteId": 164830, "siteName": "Site1" } ]}Update Tracker
Update trackers for a particular media plan used in a given campaign.
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
| mediaPlanId | string | Mandatory | path | ID of the media plan associated with a given user account |
| campaignId | string | Mandatory | path | ID of the Campaign for which Tags need to be generated |
Sample Request
xxxxxxxxxxPUT http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/trackers/:campaignIdRequest Body
xxxxxxxxxx{ "mediaPlanDetails": [ { "siteName": "string", "placementName": "string", "primaryClickTracker": "string", "secondaryClickTracker1": "string", "secondaryClickTracker2": "string", "bannerImpressionInTagPixelTracker": "string", "bannerImpressionOutTagPixelTracker": "string", "bannerImpressionInTagScriptTracker": "string", "bannerImpressionOutTagScriptTracker": "string", "creativeLoadEventTracker": "string", "mobileImpressionClickInTagPixelTracker": "string", "mobileImpressionClickOutTagPixelTracker": "string", "mobileImpressionClickInTagScriptTracker": "string", "mobileImpressionClickOutTagScriptTracker": "string", "mobileBannerClickTracker": "string", "inStreamImpressionTrackers": "string", "videoStartViewedTracker": "string", "twentyFivePercentVideoViewedTracker": "string", "fiftyPercentVideoViewedTracker": "string", "seventyFivePercentVideoViewedTracker": "string", "hundredPercentVideoViewedTracker": "string", "muteVideoViewedTracker": "string", "unmuteVideoViewedTracker": "string", "inStreamSkipAdTracker": "string" } ], "type": "inline", "isValidate": true}Sample Response
xxxxxxxxxx{ "siteUpdatedCount": 0, "siteAppendedCount": 0, "placementUpdatedCount": 0, "placementAppendedCount": 0, "trackerAppendedCount": 0, "updatedCampaignId": true, "updatedMediaPlanName": false, "errorResponse": { "secondaryClickTrackers": [ "https://google.com", "https://facebook.com" ], "primaryClickTracker": [ "https://google2.com" ] }}Was this page helpful?