Skip to main content
PUT
Update advertiser tracking configuration

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

advertiserId
string
required

Unique identifier for the advertiser

Minimum string length: 1
Example:

"12345"

Body

application/json

Request body for creating or updating advertiser tracking configuration

expected_revision
integer

Last-read revision. Rejects concurrent tracking configuration updates.

Required range: 0 <= x <= 9007199254740991
enabled_macros
enum<string>[]

System macros the advertiser wants enabled on all tracking pixels, beyond the required defaults

Maximum array length: 50

A 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:
custom_macros
object[]

Advertiser-defined custom macros (e.g., UTM parameters). Maximum 20 items.

Maximum array length: 20
impression_tracker_enabled
boolean

Whether impression tracking is enabled for this advertiser (defaults to true on first create)

click_tracker_enabled
boolean

Whether click tracking is enabled for this advertiser (defaults to true on first create)

custom_tracker_urls
object[]

Additional third-party tracker URLs for impressions, clicks, or custom events. Maximum 10 items.

Maximum array length: 10

Response

Update advertiser tracking configuration

Response containing tracking configuration

data
object
required

Full tracking configuration for an advertiser