test_apiGetReportMetadata__API.getSegmentsMetadata.xml

<?xml version="1.0" encoding="utf-8" ?>
<result>
	<row>
		<type>metric</type>
		<category>Visit</category>
		<name>Days since first visit</name>
		<segment>daysSinceFirstVisit</segment>
	</row>
	<row>
		<type>metric</type>
		<category>Visit</category>
		<name>Days since last Ecommerce order</name>
		<segment>daysSinceLastEcommerceOrder</segment>
	</row>
	<row>
		<type>metric</type>
		<category>Visit</category>
		<name>Days since last visit</name>
		<segment>daysSinceLastVisit</segment>
	</row>
	<row>
		<type>metric</type>
		<category>Visit</category>
		<name>Number of Actions</name>
		<segment>actions</segment>
	</row>
	<row>
		<type>metric</type>
		<category>Visit</category>
		<name>Number of Internal Searches</name>
		<segment>searches</segment>
		<acceptedValues>To select all visits who used internal Site Search, use: &amp;segment=searches&gt;0</acceptedValues>
	</row>
	<row>
		<type>metric</type>
		<category>Visit</category>
		<name>Number of visits</name>
		<segment>visitCount</segment>
	</row>
	<row>
		<type>metric</type>
		<category>Visit</category>
		<name>Total events</name>
		<segment>events</segment>
		<acceptedValues>To select all visits who triggered an Event, use: &amp;segment=events&gt;0</acceptedValues>
	</row>
	<row>
		<type>metric</type>
		<category>Visit</category>
		<name>Visit Duration (in seconds)</name>
		<segment>visitDuration</segment>
	</row>
	<row>
		<type>metric</type>
		<category>Visit</category>
		<name>Visitor IP</name>
		<segment>visitIp</segment>
		<acceptedValues>13.54.122.1. &lt;/code&gt;Select IP ranges with notation: &lt;code&gt;visitIp&gt;13.54.122.0;visitIp&lt;13.54.122.255</acceptedValues>
		<permission>1</permission>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit Location</category>
		<name>City</name>
		<segment>city</segment>
		<acceptedValues>Sydney, Sao Paolo, Rome, etc.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit Location</category>
		<name>Continent</name>
		<segment>continentCode</segment>
		<acceptedValues>eur, asi, amc, amn, ams, afr, ant, oce</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit Location</category>
		<name>Country</name>
		<segment>countryCode</segment>
		<acceptedValues>de, us, fr, in, es, etc.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit Location</category>
		<name>Language</name>
		<segment>languageCode</segment>
		<acceptedValues>de, fr, en-gb, zh-cn, etc.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit Location</category>
		<name>Latitude</name>
		<segment>latitude</segment>
		<acceptedValues>-33.578, 40.830, etc.&lt;br/&gt;You can select visitors within a lat/long range using &amp;segment=lat&gt;X;lat&lt;Y;long&gt;M;long&lt;N.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit Location</category>
		<name>Longitude</name>
		<segment>longitude</segment>
		<acceptedValues>-70.664, 14.326, etc.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit Location</category>
		<name>Region</name>
		<segment>regionCode</segment>
		<acceptedValues>01 02, OR, P8, etc.&lt;br/&gt;eg. region=A1;country=fr</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Browser</name>
		<segment>browserCode</segment>
		<acceptedValues>FF, IE, CH, SF, OP, etc.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Browser engine</name>
		<segment>browserEngine</segment>
		<acceptedValues>Trident, WebKit, Presto, Gecko, Blink, etc.</acceptedValues>
		<suggestedValuesCallback>\DeviceDetector\Parser\Client\Browser\Engine::getAvailableEngines</suggestedValuesCallback>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Browser version</name>
		<segment>browserVersion</segment>
		<acceptedValues>1.0, 8.0, etc.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Device brand</name>
		<segment>deviceBrand</segment>
		<acceptedValues>3Q, Acer, Ainol, Airness, Alcatel, Allview, Altech UEC, Arnova, Amazon, Amoi, Apple, Archos, ARRIS, Airties, Asus, Avvio, Audiovox, Axxion, BBK, Becker, Bird, Beetel, Bmobile, Barnes &amp; Noble, BangOlufsen, BenQ, BenQ-Siemens, Blu, Boway, bq, Brondi, Bush, CUBOT, Carrefour, Captiva, Casio, Cat, Celkon, ConCorde, Changhong, Cherry Mobile, Cricket, Crosscall, Compal, CnM, Crius Mea, CreNova, Capitel, Compaq, Coolpad, Cowon, Cube, Coby Kyros, Danew, Datang, Denver, Desay, Dbtel, DoCoMo, Dicam, Dell, DMM, Doogee, Doov, Dopod, Dune HD, E-Boda, EBEST, Ericsson, ECS, Ezio, Elephone, Easypix, Energy Sistem, Ericy, Eton, eTouch, Evertek, Ezze, Fly, Foxconn, Fujitsu, Garmin-Asus, Gateway, Gemini, Gionee, Gigabyte, Gigaset, GOCLEVER, Goly, Google, Gradiente, Grundig, Haier, Hasee, Hisense, Hi-Level, Hosin, HP, HTC, Huawei, Humax, Hyrican, Hyundai, Ikea, iBall, i-Joy, iBerry, iKoMo, i-mate, iOcean, Infinix, Innostream, Inkti, Intex, i-mobile, INQ, Intek, Inverto, iTel, Jiayu, Jolla, Karbonn, KDDI, Kingsun, Konka, Komu, Koobee, K-Touch, KT-Tech, KOPO, Koridy, Kumai, Kyocera, Kazam, Lava, Lanix, LCT, Lenovo, Lenco, Le Pan, LG, Lingwin, Loewe, Logicom, Lexibook, Majestic, Manta Multimedia, Mobistel, Mecer, Medion, MEEG, Meizu, Metz, MEU, MicroMax, Mediacom, MediaTek, Mio, Mpman, Mofut, Motorola, Microsoft, MSI, Memup, Mitsubishi, MLLED, M.T.T., MyPhone, NEC, Netgear, NGM, Nintendo, Noain, Nokia, Nomi, Nikon, Newgen, Nexian, NextBook, Onda, OnePlus, OPPO, Orange, O2, Ouki, OUYA, Opsson, Panasonic, PEAQ, Philips, Polaroid, Palm, phoneOne, Pantech, Point of View, PolyPad, Pomp, Positivo, Prestigio, ProScan, PULID, Qilive, Qtek, QMobile, Quechua, Overmax, Oysters, Ramos, RCA Tablets, Readboy, Rikomagic, RIM, Roku, Rover, Samsung, Sega, Sony Ericsson, Sencor, Softbank, SFR, Sagem, Sharp, Siemens, Sendo, Skyworth, Smartfren, Sony, Spice, SuperSonic, Selevision, Sanyo, Symphony, Smart, Star, Storex, Stonex, SunVan, Sumvision, Tesla, TCL, Telit, ThL, TiPhone, Tecno Mobile, Tesco, TIANYU, Telefunken, Telenor, T-Mobile, Thomson, Tolino, Toplux, Toshiba, TechnoTrend, Trevi, Tunisie Telecom, Turbo-X, TVC, TechniSat, teXet, Unowhy, Uniscope, UTStarcom, Vastking, Videocon, Vertu, Vitelcom, VK Mobile, ViewSonic, Vestel, Vivo, Voto, Voxtel, Vodafone, Vizio, Videoweb, Walton, Web TV, WellcoM, Wexler, Wiko, Wolder, Wonu, Woxter, Xiaomi, Xolo, Unknown, Yarvik, Yuandao, Yusun, Ytone, Zeemi, Zonda, Zopo, ZTE</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Device type</name>
		<segment>deviceType</segment>
		<acceptedValues>desktop, smartphone, tablet, feature phone, console, tv, car browser, smart display, camera, portable media player, phablet</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Local time</name>
		<segment>visitLocalHour</segment>
		<acceptedValues>0, 1, 2, 3, ..., 20, 21, 22, 23</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Operating system</name>
		<segment>operatingSystemCode</segment>
		<acceptedValues>WIN, MAC, LIN, AND, IPD, etc.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Operating system version</name>
		<segment>operatingSystemVersion</segment>
		<acceptedValues>XP, 7, 2.3, 5.1, ...</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Resolution</name>
		<segment>resolution</segment>
		<acceptedValues>1280x1024, 800x600, etc.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Server time</name>
		<segment>visitServerHour</segment>
		<acceptedValues>0, 1, 2, 3, ..., 20, 21, 22, 23</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>User ID</name>
		<segment>userId</segment>
		<acceptedValues>any non empty unique string identifying the user (such as an email address or a username).</acceptedValues>
		<permission>1</permission>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Visit Ecommerce status at the end of the visit</name>
		<segment>visitEcommerceStatus</segment>
		<acceptedValues>none, ordered, abandonedCart, orderedThenAbandonedCart. For example, to select all visits that have made an Ecommerce order, the API request would contain &quot;&amp;segment=visitEcommerceStatus==ordered,visitEcommerceStatus==orderedThenAbandonedCart&quot;</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Visit ID</name>
		<segment>visitId</segment>
		<acceptedValues>Any integer.</acceptedValues>
		<permission>1</permission>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Visit converted a specific Goal Id</name>
		<segment>visitConvertedGoalId</segment>
		<acceptedValues>1, 2, 3, etc.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Visit converted at least one Goal</name>
		<segment>visitConverted</segment>
		<acceptedValues>0, 1</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Visit type</name>
		<segment>visitorType</segment>
		<acceptedValues>new, returning, returningCustomer. For example, to select all visitors who have returned to the website, including those who have bought something in their previous visits, the API request would contain &quot;&amp;segment=visitorType==returning,visitorType==returningCustomer&quot;</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Visit</category>
		<name>Visitor ID</name>
		<segment>visitorId</segment>
		<acceptedValues>34c31e04394bdc63 - any 16 Hexadecimal chars ID, which can be fetched using the Tracking API function getVisitorId()</acceptedValues>
		<permission>1</permission>
	</row>
	<row>
		<type>dimension</type>
		<category>Referrers</category>
		<name>Keyword</name>
		<segment>referrerKeyword</segment>
		<acceptedValues>Encoded%20Keyword, keyword</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Referrers</category>
		<name>Referrer Name</name>
		<segment>referrerName</segment>
		<acceptedValues>twitter.com, www.facebook.com, Bing, Google, Yahoo, CampaignName</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Referrers</category>
		<name>Referrer Type</name>
		<segment>referrerType</segment>
		<acceptedValues>direct, search, website, campaign</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Referrers</category>
		<name>Referrer URL</name>
		<segment>referrerUrl</segment>
		<acceptedValues>http%3A%2F%2Fwww.example.org%2Freferer-page.htm</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Events</category>
		<name>Event Action</name>
		<segment>eventAction</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Events</category>
		<name>Event Category</name>
		<segment>eventCategory</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Events</category>
		<name>Event Name</name>
		<segment>eventName</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name (scope visit)</name>
		<segment>customVariableName</segment>
		<unionOfSegments>
			<row>customVariableName1</row>
			<row>customVariableName2</row>
			<row>customVariableName3</row>
			<row>customVariableName4</row>
			<row>customVariableName5</row>
		</unionOfSegments>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 1 (scope visit)</name>
		<segment>customVariableName1</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 2 (scope visit)</name>
		<segment>customVariableName2</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 3 (scope visit)</name>
		<segment>customVariableName3</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 4 (scope visit)</name>
		<segment>customVariableName4</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 5 (scope visit)</name>
		<segment>customVariableName5</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name (scope page)</name>
		<segment>customVariablePageName</segment>
		<unionOfSegments>
			<row>customVariablePageName1</row>
			<row>customVariablePageName2</row>
			<row>customVariablePageName3</row>
			<row>customVariablePageName4</row>
			<row>customVariablePageName5</row>
		</unionOfSegments>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 1 (scope page)</name>
		<segment>customVariablePageName1</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 2 (scope page)</name>
		<segment>customVariablePageName2</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 3 (scope page)</name>
		<segment>customVariablePageName3</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 4 (scope page)</name>
		<segment>customVariablePageName4</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable name 5 (scope page)</name>
		<segment>customVariablePageName5</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value (scope page)</name>
		<segment>customVariablePageValue</segment>
		<unionOfSegments>
			<row>customVariablePageValue1</row>
			<row>customVariablePageValue2</row>
			<row>customVariablePageValue3</row>
			<row>customVariablePageValue4</row>
			<row>customVariablePageValue5</row>
		</unionOfSegments>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 1 (scope page)</name>
		<segment>customVariablePageValue1</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 2 (scope page)</name>
		<segment>customVariablePageValue2</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 3 (scope page)</name>
		<segment>customVariablePageValue3</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 4 (scope page)</name>
		<segment>customVariablePageValue4</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 5 (scope page)</name>
		<segment>customVariablePageValue5</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value (scope visit)</name>
		<segment>customVariableValue</segment>
		<unionOfSegments>
			<row>customVariableValue1</row>
			<row>customVariableValue2</row>
			<row>customVariableValue3</row>
			<row>customVariableValue4</row>
			<row>customVariableValue5</row>
		</unionOfSegments>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 1 (scope visit)</name>
		<segment>customVariableValue1</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 2 (scope visit)</name>
		<segment>customVariableValue2</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 3 (scope visit)</name>
		<segment>customVariableValue3</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 4 (scope visit)</name>
		<segment>customVariableValue4</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Custom Variables</category>
		<name>Custom Variable value 5 (scope visit)</name>
		<segment>customVariableValue5</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Action Type</name>
		<segment>actionType</segment>
		<acceptedValues>A type of action, such as: pageviews, contents, sitesearches, events, outlinks, downloads</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Action URL</name>
		<segment>actionUrl</segment>
		<unionOfSegments>
			<row>pageUrl</row>
			<row>downloadUrl</row>
			<row>outlinkUrl</row>
		</unionOfSegments>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Clicked URL</name>
		<segment>outlinkUrl</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Content Name</name>
		<segment>contentName</segment>
		<acceptedValues>The name of a content block, for instance &quot;Ad Sale&quot;</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Content Piece</name>
		<segment>contentPiece</segment>
		<acceptedValues>The actual content. For instance &quot;ad.jpg&quot; or &quot;My text ad&quot;</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Content Target</name>
		<segment>contentTarget</segment>
		<acceptedValues>For instance the URL of a landing page: &quot;http://landingpage.example.com&quot;</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Download URL</name>
		<segment>downloadUrl</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Entry Page URL</name>
		<segment>entryPageUrl</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Entry Page title</name>
		<segment>entryPageTitle</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Exit Page Title</name>
		<segment>exitPageTitle</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Exit Page URL</name>
		<segment>exitPageUrl</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Interaction</name>
		<segment>contentInteraction</segment>
		<acceptedValues>The type of interaction with the content. For instance &quot;click&quot; or &quot;submit&quot;.</acceptedValues>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Keyword (Site Search)</name>
		<segment>siteSearchKeyword</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Page Name</name>
		<segment>pageTitle</segment>
	</row>
	<row>
		<type>dimension</type>
		<category>Actions</category>
		<name>Page URL</name>
		<segment>pageUrl</segment>
		<acceptedValues>All these segments must be URL encoded, for example: http%3A%2F%2Fexample.com%2Fpath%2Fpage%3Fquery</acceptedValues>
	</row>
</result>