Custom field API XML reference

Use the following response hierarchies as a reference to XML returned in response to requests that you send to custom field configuration API.

Hierarchy

<customFields>

The <customFields> element is the container for all custom field definitions.

<customFields> child elements

<customField>

The <customField> element contains the name, description, and extractions for a given custom field.

<customField> child elements

<customField> attributes

<extractions>

The container for a set of extractions or for one default extraction.

<extractions> child elements

<defaultExtraction>

The <defaultExtraction> element contains the source and transformation set for a default extraction.

<defaultExtraction> child elements

<extraction>

The <extraction> element contains the name, filtering, source, and transformations for a single extraction. Every extraction needs some form of filtering to be specified, whether as a domain reference, an expression, or both.

<extraction> child elements

<source>

The <source> element is a container for the extraction source.

<source> child elements

<sourceCookieParam>

The <sourceCookieParam> element identifies a specific cookie as the data source for a custom field.

<sourceCookieParam> child elements

<sourceCustomField>

The <sourceCustomField> element identifies a specific custom field as the data source for the new custom field.

<sourceCustomField> child elements

<sourceGeoip />

The <sourceGeoip> element identifies a geolocation field as the data source for a custom field.
This element is always empty.

<sourceGeoip> attributes

<sourceHTTPContent>

The <sourceHTTPContent> element identifies the HTTP content as the data source for a custom field.

<sourceHTTPContent> child elements

<sourceHTTPContent> attributes

<linearSearch>

The <linearSearch> element defines a simple linear search for a specified string with an optional ability to capture content. If no content is specifically extracted, then the value provided is a Boolean value indicating whether the specified string was found.

<linearSearch> child elements

<targetString>

The <targetString> element indicates that content must be captured, starting from the <findstring> and until either the target strinig is found or until the character limit specified for the source has been reached.

<targetString> attributes

<sourceHTTPHeader>

The <sourceHTTPHeader> element identifies a specific HTTP header as the data source for the custom field.

<sourceHTTPHeader> child elements

<sourceHTTPHeader> attributes

<sourcePathParam>

The <sourcePathParam> element identifies a specific path parameter as the data source for the custom field.

<sourcePathParam> child elements

<sourcePathParam> attributes

<sourcePostParam>

The <sourcePostParam> element identifies a specific POST parameter as the data source for a custom field.

<sourcePostParam> child elements

<sourceRedirectPathParam />

The <sourceRedirectPathParam /> element identifies the redirect path parameter as the data source for the custom field.

<sourceRedirectPathParam> child elements

<sourceRedirectPathParam /> attributes

<sourceRedirectURIStem />

The <sourceRedirectURIStem /> element identifies the redirect URI stem as the data source for a custom field.

This element is always empty.

<sourceRedirectURIStem /> attributes

<sourceReferrerPathParam />

The <sourceReferrerPathParam /> element identifies the referrer path parameter as the data source for the custom field.

<sourceReferrerParam> child elements

<sourceReferrerPathParam /> attributes

<sourceReferrerQueryParam />

The <sourceReferrerQueryParam /> element identifies the referrer query parameter as the data source for a custom field.

<sourceReferrerQueryParam> child elements

<sourceReferrerURIStem />

The <sourceReferrerURIStem /> element identifies the referrer URI stem as the data source for a custom field.

This element is always empty.

<sourceReferrerURIStem /> attributes

<sourceSetCookieParam>

The <sourceSetCookieParam> identifies a specific server cookie as the data source for the custom field.

<sourceCookieParam> child elements

<transformations>

The <transformations> element is a container for a set of transformations that you can apply to the extracted data.

<transformations> child elements

<afterInstanceStringTransform>

The <afterInstanceStringTransform> element defines a transform that extracts/strips a substring after the nth occurrence of a given string.

<afterInstanceStringTransform> child elements

<afterInstanceStringTransform> attributes

<betweenInstancesStringTransform>

The <betweenInstancesStringTransform> element defines a transform that extracts/strips between two instances of the same string.

<betweenInstancesStringTransform> child elements

<betweenInstancesStringTransform> attributes

<endInstance/>

The <endInstance /> element defines the end of the extraction or strip operation.

This element is always empty.

<endInstance /> attributes

<startInstance />

The <startInstance /> element defines the start of the extraction or strip operation.

<startInstance /> attributes

<betweenStringsTransform>

The <betweenStringsTransform> element defines a transform that extracts or strips a substring between two different strings.

<betweenStringsTransform> child elements

<betweenStringsTransform> attributes

<endstring>

The string that marks the end of the extraction. The substring operation will only extract characters found before this string. If this child element is missing, the substring grabs all remaining characters in the parent string.

<endstring> attributes

<startstring>

The <startstring> element defines the string that marks the beginning of the extraction. The substring operation will only extract characters that are found after this string. If this child element is missing, the substring will start from the first character in the parent string.

<startstring> attributes

<caseTransform />

The <caseTransform /> element defines a trasform that converts the character case of the target string.

This element is always empty.

<caseTransform /> attributes

<geoLookupTransform>

The <geoLookupTransform> element defines a transform that converts geolocation to a specific field value.

<geoLookupTransform> child elements

<fields>

The <fields> element is the container for one or more <field> elements.

<fields> child elements

<indexTransform />

The <indexTransform /> element defines an index-based substring.

This element is always empty.

<indexTransform /> attributes

<integerIPTransform>

The <integerIPTransform> element defines a transform that converts an integer to an IP address.

<integerIPTransform > attributes

<ipIntegerTransform>

The <ipIntegerTransform> element defines a transform that converts an IP address to an integer.

<ipIntegerTransform > attributes

<ipMapTransform>

The <ipMapTransform> element defines a transform that uses the target string as an IP address to look up a string-based result.

<ipMapTransform> child elements

<defaultMode />

The <defaultMode /> element defines the way that the default value is determined.

This element is always empty.

<defaultMode /> attributes

<mapping>

The <mapping> element contains the source and target values for a single map entry in a map transform.

<mapping> child elements

<mapRef />

The <mapRef /> element defines a reference to a mapping file. This allows the configuration to avoid having to contain hundreds or thousands of <mapping> elements.

This element is always empty.

<mapRef /> attributes

<leftTransform />

The <leftTransform /> element defines a transform that extracts a specific number of characters from the beginning of the target string.

This element is always empty.

<leftTransform/> attributes

<mapTransform>

The <mapTransform> element defines a transform that uses the target string to look up a string-based result.

<mapTransform> child elements

<prependAppendTransform>

The <prependAppendTransform> element defines a transform that prepends and/or appends a fixed string to the custom field value.

<sourceCookieParam> child elements

<regexTransform>

The <regexTransform> element defines a transform that uses regex to extract a result from the target string.

<regexTransform> child elements

<regexTransform> attributes

<replaceTransform>

The <replaceTransform> element defines a transform that replaces the custom field value with another.

<replaceTransform> child elements

<replaceTransform> attributes

<rightTransform />

The <rightTransform /> element defines a right transform that extracts a specific number of characters from the end of the target string.

This element is always empty.