You can append one or more of the following macros to your External Tracking URL in order to provide additional information to your third party impression trackers. For each impression sent to the tracker, the information you specify will automatically populate in the URL.


Macros

Macro
Description
Example
request_query(<name of query parameter>)Returns the value of a query parameter received by AudioSSP.%%request_query(content_categories)%%
request_header(<name of header>)Returns the value of a header parameter received by AudioSSP%%request_header(X-Device-IP)%%
first_party(<name of value>)Returns the first party information available for use%%first_party(device_type)%%
normalized_request_query(<name of query parameter>)
Returns the normalized value of a query parameter received by AudioSSP
%%normalized_request_query(content_categories)%%
timestampReturns the current timestamp (number of seconds elapsed since Jan 1st 1970 UTC). This can be used to ensure unique URLs in situations where you’d otherwise be sending identical information, for example when multiple impressions come from the same place.%%timestamp%%
randomReturns a random string of 40 characters. This can be used to ensure unique URLs in situations where you’d otherwise be sending identical information, for example when multiple impressions come from the same place.%%random%%


You can use the first_party macro with one or more of the below First Party Data Keys to dynamically populate your external tracking URL with specific information about each delivered impression. Third party trackers validate your impressions to your ad partner. You can also use a tracker to demonstrate the quality of your impressions, useful when negotiating direct ad deals. 


First Party Data 

Keys

Name
Description
ipListener IP Address
user_agentListener User Agent
refererListener Referrer
sidSession ID (currently UUID v4)
geo_countryGeographical Country inferred from IP
geo_regionGeographical Region inferred from IP
geo_region_codeGeographical Region Code inferred from IP. States, provinces and territories use their established two letter abbreviation. All other regions use this mapping.
geo_cityGeographical City inferred from IP
geo_postalcodePostal Code inferred from IP
geo_timezoneListener Timezone, inferred from IP
geo_latitudeGeographical latitude, inferred from IP
geo_longitudeGeographical longitude, inferred from IP
geo_dmaGeographical DMA, inferred from IP
show_idPodcast show ID
show_namePodcast show name
episode_idPodcast episode ID
content_countryContent country
content_languageContent language
content_categoriesList of IAB categories describing the content
content_genreContent genre
blocked_categoriesList of blocked IAB categories
allowed_categoriesList of allowed IAB categories
blocked_advertisersList of blocked advertisers
publisher_namePublisher name
publisher_idPublisher ID
publisher_typePublisher Type, example: Podcast, Radio etc.
publisher_domainPublisher domain, example: live365.com
rssRSS feed
bundle_idBundle ID
store_urlStore URL (for player apps)
listener_idListener ID, usually specified by a streaming server
app_namePlayer app name, inferred from User Agent
bot_nameBot name, inferred from User Agent
is_botBoolean indicating whether the player app is a bot or not, inferred from User Agent
browserListener browser details, inferred from User Agent
deviceListener device detail, inferred from User Agent
device_typeListener device type, inferred from User Agent
library_nameApplication library used by the listener, inferred from User Agent
position_nameAd break position “name”, example: pre1
position_typeAd break position type, one of: preroll, midroll, postroll, inferred from position_name
seller_idSeller id corresponding to the publisher and included in our sellers.json page
sidUnique session ID in the form of an UUID v4 field
id5_tokenID5 token associated to the IP address
soundstack_user_idHash of IP and User Agent
is_datacenterBoolean flag indicating whether IP was detected as part of a datacenter network. This suggests the impression comes from a

Examples

https://example.domain.com/tracking/pixel?publisherId=%%first_party(publisher_id)%%&rn=%%random%%&ip=%%first_party(ip)%%

In this example, the URL would contain the publisher ID, a string of random characters, and the IP address of the listener for every impression.


https://example.domain.com/tracking/pixel?is_bot=%%first_party(is_bot)%%&rn=%%random%%&episode_id=%%first_party(episode_id)%%

In this example, the URL would contain a true/false result if the impression comes from a bot, a string of random characters, and the episode ID for every impression.