Supported XML Tags and Query Variables
The following table lists all supported XML tags, along with their associated query string variable equivalents and HTTP header variable equivalents, where applicable.
When sending HTTP POST data, Adobe data collection servers only process values in supported XML tags. When sending HTTP GET data, Adobe data collection servers only process values in supported query strings and HTTP headers.
Required components
Every Data Insertion API call must include the following components:
- At least one of:
<marketingCloudVisitorId><fallbackVisitorId><visitorId><ipAdress>and<userAgent>
- At least one of:
<pageUrl><pageName><linkType>with<linkName>or<linkUrl>
- Report suite ID (in the request URL for
GETor<reportSuiteId>forPOST)
API calls that do not meet the above requirements are omitted from reporting. XML tags are not case-sensitive; capitalization is used only to assist readability.
XML tag (POST) | Query string parameter (GET) | Description |
|---|---|---|
<browserHeight> | bh | The Browser height dimension. |
<browserWidth> | bw | The Browser width dimension. |
<campaign> | v0 | The Tracking code dimension. |
<channel> | ch | The Site section dimension. |
<colorDepth> | c | The Color depth dimension. |
<connectionType> | ct | The Connection type dimension. |
<contextData.key> | c.[key] | contextData implementation variables. |
<cookiesEnabled> | k | The Cookie support dimension. |
<customerPerspective> | cp | Integer representing if the hit is considered a background or foreground hit. Valid values include 0 (foreground hit, default) and 1 (background hit). See Context-aware sessions. |
<currencyCode> | cc | The currencyCode implementation variable. |
<eVar1> - <eVar250> | v1 - v250 | eVar dimensions. |
<events> | events | The events implementation variable. |
<fallbackVisitorId> | fid | A fallback cookie s_fid is set when the primary cookie (AMCV_ or s_vi) is unavailable. It has a 2 year expiration and is used as the fallback identification method going forward. |
<hier1> - <hier5> | h1 - h5 | |
<imsRegion> | aamlh | Integer that represents the Adobe Audience Manager location hint. Ensures that data is forwarded to the right Audience Manager regional data collection center. The Analytics tracking server/API endpoint must also be set to forward to the correct Audience Manager instance before Analytics data is forwarded to Audience Manager. Use the getLocationHint function of the Adobe Experience Cloud Identity Service API to retrieve the correct <imsregion> value for the user. The <marketingCloudVisitorID> tag is also required when using this tag. |
<ipAddress> | X-Forwarded-For HTTP header | The visitor's IP address. |
<javaEnabled> | v | The Java enabled dimension. |
<language> | Accept-Language HTTP header | The Language dimension. |
<linkName> | pev2 | The Download link, Exit link, or Custom link dimension, depending on the value in the <linkType> tag. If this tag contains a value, <pageName> is ignored. |
<linkType> | pe | The type of link. Defaults to o if this tag is empty or omitted and <linkName> contains a value. Valid values include:d: Download linke: Exit linko: Custom link |
<linkUrl> | pev1 | The link URL. |
<list1> - <list3> | l1 - l3 | |
<marketingCloudOrgId> | mcorgid | The Experience Cloud Organization ID; it identifies the organization within the Adobe Experience Cloud. |
<marketingCloudVisitorId> | mid | The unique identifier used with the Adobe Experience Cloud Identity Service. |
<pageName> | pageName | The Page dimension. |
<pageType> | pageType | The pageType implementation variable. Set to the string value "errorPage" on any error pages, such as a 404 or 503 error. |
<pageUrl> | g | The Page URL dimension. |
<products> | products | The products implementation variable. |
<prop1> - <prop75> | c1 - c75 | Prop dimensions. |
<purchaseId> | purchaseID | The purchaseID implementation variable. |
<referrer> | r | The referrer implementation variable. |
<reportSuiteId> | Include in GET URL | Specifies the report suite(s) where you want to submit data. Separate multiple report suite IDs with a comma. |
<resolution> | s | The Monitor resolution dimension. |
<scXmlVer> | N/A | Analytics XML request version number. For example, 1.0. |
<server> | server | The Server dimension. |
<timestamp> | ts | The date and time that the data was collected. Unix Time and ISO-8601 are supported. Milliseconds are not allowed. See Timestamps Optional for more information. |
<transactionId> | xact | The transactionID variable. |
<userAgent> | User-Agent HTTP header | The device's user agent string. |
<userAgentClientHints> | h.[key] | Client Hint fundamentals. See child fields below. |
<visitorId> | vid | The visitorID implementation variable. |
<zip> | zip | The Zip code dimension. |
User Agent Client Hint fields
The <userAgentClientHints> XML element serves as the parent node to contain client hint elements. Alternatively, the fields can also be submitted as query string parameters.
| XML tag | Query string parameter | Data type |
|---|---|---|
<architecture> | h.architecture | String |
<bitness> | h.bitness | String |
<brands> | h.brands | Can contain 1 or more <brand> records. For example, <brand><name>Chromium</name><version>100</version></brand>. Query string example: [{"brand":"Chromium", "version":"100"}] |
<mobile> | h.mobile | Boolean |
<model> | h.model | String |
<platform> | h.platform | String |
<platformVersion> | h.platformversion | String |
<wow64> | w.wow64 | Boolean |
See User-agent client hints in the Adobe Experience Platform Web SDK user guide for more information.
The following is an example <userAgentClientHints> XML object:
Copied to your clipboard<userAgentClientHints><architecture>x64</architecture><bitness>64</bitness><brands><brand><name>Chromium</name><version>96</version></brand></brands><mobile>false</mobile><platform>Windows</platform><platformVersion>NT 10.0</platformVersion><wow64>true</wow64></userAgentClientHints>
