Update advertiser tracking configuration
curl --request PUT \
--url https://api.apostra.com/api/v2/buyer/advertisers/{advertiserId}/tracking-config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.apostra.com/api/v2/buyer/advertisers/{advertiserId}/tracking-config"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.apostra.com/api/v2/buyer/advertisers/{advertiserId}/tracking-config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"advertiser_id": "12345",
"enabled_macros": [
"CAMPAIGN_ID"
],
"custom_macros": [
{
"name": "UTM_SOURCE",
"param_key": "utm_source",
"description": "Identifies the traffic source for UTM tracking"
}
],
"macro_additions": [
{
"param_key": "<string>",
"value": "<string>"
}
],
"impression_tracker_enabled": true,
"click_tracker_enabled": true,
"custom_tracker_urls": [
{
"tracker_id": "trk_0123456789abcdef01234567",
"name": "DoubleVerify Impression",
"url": "https://tracker.doubleverify.com/pixel?id=123",
"tracker_type": "IMPRESSION",
"raw_url": "<string>",
"enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_event_name": "<string>",
"vendor_name": "HappyDemics",
"gvl_vendor_id": 550,
"source_dialect": "adcp",
"compiler_version": "<string>",
"mapping_artifact": {}
}
],
"revision": 4503599627370495,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-20T14:45:00Z",
"creative_resync": {
"creative_count": 3,
"seller_count": 2
}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Advertisers
Update advertiser tracking configuration
Replace selected advertiser-level macro and tracker settings. Trackers are inherited by campaigns by stable ID; return tracker_id on subsequent updates to preserve identity.
PUT
/
advertisers
/
{advertiserId}
/
tracking-config
Update advertiser tracking configuration
curl --request PUT \
--url https://api.apostra.com/api/v2/buyer/advertisers/{advertiserId}/tracking-config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.apostra.com/api/v2/buyer/advertisers/{advertiserId}/tracking-config"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.apostra.com/api/v2/buyer/advertisers/{advertiserId}/tracking-config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"advertiser_id": "12345",
"enabled_macros": [
"CAMPAIGN_ID"
],
"custom_macros": [
{
"name": "UTM_SOURCE",
"param_key": "utm_source",
"description": "Identifies the traffic source for UTM tracking"
}
],
"macro_additions": [
{
"param_key": "<string>",
"value": "<string>"
}
],
"impression_tracker_enabled": true,
"click_tracker_enabled": true,
"custom_tracker_urls": [
{
"tracker_id": "trk_0123456789abcdef01234567",
"name": "DoubleVerify Impression",
"url": "https://tracker.doubleverify.com/pixel?id=123",
"tracker_type": "IMPRESSION",
"raw_url": "<string>",
"enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_event_name": "<string>",
"vendor_name": "HappyDemics",
"gvl_vendor_id": 550,
"source_dialect": "adcp",
"compiler_version": "<string>",
"mapping_artifact": {}
}
],
"revision": 4503599627370495,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-20T14:45:00Z",
"creative_resync": {
"creative_count": 3,
"seller_count": 2
}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Path Parameters
Body
application/json
Request body for creating or updating advertiser tracking configuration
System macros the advertiser wants enabled on all tracking pixels, beyond the required defaults
Maximum array length:
50A valid system macro name for tracking pixels
Available options:
CAMPAIGN_ID, CREATIVE_ID, TRACKING_TAG_ID, DATA_SET_ID, TACTIC_ID, MEDIA_BUY_ID, SALES_AGENT_ID, ATTRIBUTION_TRACKING_ID, DEVICE_ID, DEVICE_ID_TYPE, CACHEBUSTER, GDPR, GDPR_CONSENT, US_PRIVACY, LIMIT_AD_TRACKING, DEVICE_TYPE, OS, OS_VERSION, DEVICE_MAKE, DEVICE_MODEL, APP_BUNDLE, APP_NAME, COUNTRY, REGION, CITY, ZIP, DMA, LAT, LONG, PLACEMENT_ID, FOLD_POSITION, AD_WIDTH, AD_HEIGHT, VIDEO_ID, VIDEO_TITLE, VIDEO_DURATION, VIDEO_CATEGORY, CONTENT_GENRE, CONTENT_RATING, PLAYER_WIDTH, PLAYER_HEIGHT, POD_POSITION, POD_SIZE, AD_BREAK_ID, AXEM, TIMESTAMP Example:
["CAMPAIGN_ID", "CREATIVE_ID", "DEVICE_TYPE"]