Livestream API variable reference

Lists the dimensions and metrics that are available in the Livestream API.

data-variant=note

data-slots=text

The dimensions and metrics listed below can change over time. Make sure that your Livestream client can handle changes to available components.

Dimension or Metric

Type

Description

bot

string

Determines if the hit matched Bot rules Valid values include \<Bot\> and \<Not a bot\>.

browser

string

The Browser dimension.

browserHeight

number

The Browser height dimension.

browserWidth

number

The Browser width dimension.

campaign

See evars.

carrier

string

The Mobile carrier dimension.

connectionType

string

The Connection type dimension.

currency

string

The currencyCode implementation variable used for the hit.

customVisId

string

The visitorID implementation variable used for the hit.

evars

object

An object that contains all eVars as well as the Tracking code dimension.

events

object

An object that contains metric data for the hit, including Cart additions, Cart removals, Cart views, Carts, Checkouts, Product views, Revenue, and Custom events. Each item contains an object array that holds data for an individual event. That data includes: - count (number): The amount to increment the metric by. - exponent (number): The number of decimal places to move count. - unique (string): The value used for Event serialization.

exclude

object

An object that indicates if the hit is excluded in Analytics reporting. Components within the object include: - id (number): The numeric ID representing the exclude reason. See exclude_hit in Data feed column reference. - value (string): Determines if the hit is excluded. Valid values include yes (hit is excluded) and no (hit is included). - description (string): Exclude reason description.

geoCity

string

The Cities dimension.

geoCountry

string

The Countries dimension.

geoDMA

number

Numeric ID used in the US DMA dimension.

geoRegion

string

The Regions dimension.

geoZip

string

The Zip code dimension, if Report suite settings indicate that geosegmentation data is used. See also zip.

hierarchies

object

An object containing data for Hierarchy dimensions. Each array item contains delim (string) and values (string[]).

hitIdHigh

number

Used in combination with hitIdLow to uniquely identify a hit. Only available in Data feeds.

hitIdLow

number

Used in combination with hitIdHigh to uniquely identify a hit. Only available in Data feeds.

hitSource

number

Indicates what source the hit came from. Only available in Data feeds.

ip

string

The IP address of user's computer. Only available in Data Warehouse and Data feeds.

isErrorPage

boolean

Determines the value in the Pages not found dimension.

javaEnabled

boolean

The Java enabled dimension.

language

string

The Language dimension.

languageAbbrev

string

Language abbreviation of the browser.

lat

string

Latitude of the hit based on the location associated with the IP address. Only available in Data feeds.

lon

string

Longitude based on the location associated with the IP address. Only available in Data feeds.

mcAudiences

object

An object containing segment IDs from Adobe Audience Manager's Server-side Forwarding integration. Items include values (string[]), and delim (number).

mcVisIdHigh

number

Used in combination with mcVisIdLow that represents the Experience Cloud visitor ID.

mcVisIdLow

number

Used in combination with mcVisIdHigh that represents the Experience Cloud visitor ID.

mobileAudioSupport

boolean

The Mobile audio support dimension. If your stream is configured to use userAgent, this field is always false.

mobileColorDepth

number

The Mobile color depth dimension. If your stream is configured to use userAgent, this field is always 0.

mobileCookieSupport

boolean

The Mobile cookie support dimension. If your stream is configured to use userAgent, this field is always false.

mobileDeviceName

string

The Mobile device dimension. If your stream is configured to use userAgent, this field is always empty.

mobileDeviceType

string

The Mobile device type dimension. If your stream is configured to use userAgent, this field is always empty.

mobileManufacturer

string

The Mobile manufacturer dimension. If your stream is configured to use userAgent, this field is always empty.

mobileScreenHeight

number

The Mobile screen height dimension. If your stream is configured to use userAgent, this field is always 0.

mobileScreenWidth

number

The Mobile screen width dimension. If your stream is configured to use userAgent, this field is always 0.

mobileVideoSupport

boolean

The Mobile video support dimension. If your stream is configured to use userAgent, this field is always false.

monitorColorDepth

string

The Color depth dimension.

monitorHeight

number

Used in combination with monitorWidth that represents the Monitor resolution dimension.

monitorWidth

number

Used in combination with monitorHeight that represents the Monitor resolution dimension.

mvvars

object

An object containing data for each List variable. Each list var contains m (object), which contains values (string[]) and delim (number).

operatingSystem

string

The Operating system dimension.

pageName

string

The Page dimension.

pageURL

string

The Page URL dimension.

props

object

An object that contains all Props as well as the Site section dimension.

products

object[]

An object array that contains similar data to the products implementation variable. Each object includes category (string), evars (object), events (object[]), name (string), revenue (number), and units (number).

purchaseId

string

The purchaseID implementation variable.

receivedTimeGMT

number

The timestamp when Adobe data collection servers received the hit, based in Unix time. Only available in Data feeds as hit_time_gmt.

referrer

string

The Referrer dimension.

reportSuite

string

The report suite ID that the hit was sent to.

searchEngine

string

The Search engine dimension.

service

string

No longer used. Use page_event instead.

site_section

See props.

timeGMT

number

The timestamp that the hit applies to. If the hit did not contain a custom timestamp, this field typically matches receivedTimeGMT.

tnt

object

Field used in A4T.

tntAction

object

Action used in A4T.

topLevelDomain

string

The Domain dimension.

transactionId

string

The transactionID implementation variable.

truncated

boolean

A boolean that indicates if a complete hit was sent.

userAgent

string

The user agent string. Only available in Data feeds. By default, this field is empty. It is mutually exclusive with mobile device attribute fields. If you prefer, you can contact Customer Care and request that a given stream populates this field. However in doing so, the following fields no longer populate with data: mobileDeviceType, mobileDeviceName, mobileManufacturer, mobileScreenWidth, mobileScreenHeight, mobileCookieSupport, mobileColorDepth, mobileAudioSupport, and mobileVideoSupport.

usesPersistentCookie

number

The Persistent cookie support dimension. Valid values include 0 (Unknown), 1 (Supported), and 2 (Unsupported).

visIdHigh

number

Used in combination with visIdLow to uniquely identify a visitor. Only available in Data feeds.

visIdLow

number

Used in combination with visIdHigh to uniquely identify a visitor. Only available in Data feeds.

visIdType

number

Numeric ID representing the method used to identify the visitor. Only available in Data feeds.

zip

string

The Zip code dimension, if Report suite settings indicate that the zip variable is used. See also geo_zip.

See Livestream sample JSON output for a full example JSON request.