API Field Reference: Dimensions
A Dimension is an independent value, and a Metric is a calculated value for the requested Dimension. In Angelfish, each Dimension is either Visit-level or Hit-level, depending on the type of data the Dimension is used to show.
MARKETING
PAGE
USAGE COSTS
API requests typically include a combination of Dimensions and Metrics.
Visit-Level Dimensions
A Visit-level Dimension is any value stored in relation to a Visit.
Visit-level Dimensions are linked to specific Visits, and are linked to Visitors if the Profile's Tracking Method supports Visitors.
There are 6 subsections for Visit-level Dimensions:
- Standard
- Time Intervals
- Marketing
- Page
- Internal Search
- Usage Costs
STANDARD
| Dimension | Description |
|---|---|
| browsername | The name of the Browser used during a Visit, e.g. Chrome. |
| browserversion | The version of the browser used during a Visit. |
| bouncestem | The Page associated with a Bounce Visit. |
| city | The city in which the Visit originates, determined by a geo lookup of the IP address. |
| colordepth | The color depth (number of colors) of the Browser. AGF only. |
| countrycode | The 2-letter ISO_3166-1 country code for the visitor, determined by a geo lookup of the IP address. |
| countryname | The Country name in which the Visit originates, determined by a geo lookup of the IP address. |
| firsttime | A timestamp in GMT epoch seconds for the first Pageview of a Visit. |
| goal | The number of the goal completed during the visit. (e.g. 1 through 5) |
| ip | The Client IP address of the Visit. |
| javaenabled | Boolean: Java enabled in the user's browser = 1, Java disabled (or not available) = 0<. AGF only./td> |
| jsversion | The javascript version used by the browser during a Visit. AGF only. |
| language | The active language in the Browser during a Visit. AGF only. |
| lasttime | A timestamp in GMT epoch seconds for the last Page of a Visit. |
| metrocode | The code for the metropolitan region of the Visit's location (USA only), determined by a geo lookup of the IP Address. |
| metroname | The name of the metropolitan region for the user's location (USA only), determined by a geo lookup of the IP address. |
| mobile | Each Visit is categorized as "desktop" or "mobile" depending on the user agent. |
| mobile_device | The Mobile Devices used by Visits during the selected date range. |
| platformname | The name of the user's platform | OS, e.g., Windows. |
| platformversion | The version of the user's platform | OS. |
| regioncode | The 2-letter code for the State | Region | Province observed in the Visit, determined by a geo lookup of the IP address. |
| regionname | The name of the State | Region | Province observed in the Visit, determined by a geo lookup of the IP address. |
| screenheight | The height (in pixels) of the screen used in the Visit. AGF only. |
| screenwidth | The width (in pixels) of the screen used in the Visit. AGF only. |
| serviceprovider | The name of the Organization registered to the IP address used in the Visit. |
| udv | The value of the user-defined variable for the Visit. |
| username | The Username associated with the Visit. |
| visitid | The ID of the Visit. |
| visitorid | The unique ID of the Visitor. |
| visitortype | "new" if the Visit is the first for a Visitor, "returning" otherwise. |
TIME INTERVALS
| Dimension | Description |
|---|---|
| day | Date stamp in YYYYMMDD format |
| dayofweek | Day of week: Monday, Tuesday, Wednesday, etc. |
| hour | Date/time stamp in YYYYMMDDHH format |
| hourofday | Hour of day time stamp in HH format: 00, 12, 23, etc. |
| minute | Date/time stamp in YYYYMMDDMM format |
| month | Date stamp in YYYYMM format |
| second | Date/time stamp in YYYYMMDDMMSS format |
| week | Date stamp of the first day of the week, in YYYYMMDD format |
| year | Date stamp in YYYY format |
| Dimension | Description |
|---|---|
| campaign | External MV: the name of the campaign attached to the visit. Default value = (not set) |
| medium | External MV: the method which referred the Visit, e.g. organic, email, cpc, banner |
| keyword | External MV: stores the keyword from search engine referrals |
| source | External MV: the website (e.g. google) or entity (e.g. 20140428-newsletter) which referred the Visit to the website. |
| variation | External MV: the value of the Variation field for the visit, used to differentiate between similar links. Default value = (not set) |
| referralhostname | External MV: stores the actual Hostname from the referrer field in the log, if available. |
| referralpage | External MV: contains the request stem of the from the referrer field in the log, if available. |
| impr_file_ext | The Impression Filename linked to External MVs |
| impr_file_int | The Impression Filename linked to Internal MVs |
| imv_campaign | Internal MV: Internal Campaigns that received click activity during the selected date range. |
| imv_medium | Internal MV: Internal Mediums that received click activity during the selected date range. |
| imv_variation | Internal MV: Internal Variations that received click activity during the selected date range. |
| imv_destination | Internal MV: the Page that loads after a link with Internal MVs is clicked. |
| imv_origin | Internal MV: the Page that contains a clickable element with Internal MVs in the destination URL. |
| imv_usage | Internal MV: identifies Visits that interact with Internal MVs separately from Visits that don't use them. |
| Dimension | Description |
|---|---|
| document | Documents are Pages that match a specified File Type, observed during the date range. |
| documenttype | The File Type for each Document observed during the date range. |
| pagefiletype | The File Type for Pages requested during the date range. |
| pagehostname | The Hostname(s) for all Pages viewed. |
| pagehostname:{N} | The Hostname for Pages requested during a Visit. Replace {N} with the Pageview number to retrieve. pagehostname:2 returns the Hostname for the second Page viewed in a Visit. |
| pagereferrerstem | The Page of the previous Pageview. |
| pagestem | The URI reference (stem + query) of all Pages requested during the date range. |
| pagestem:{N} | The URI reference (stem + query) for Pages requested during a Visit. Replace {N} with the page number to retrieve. pagestem:2 returns the stem for the second Page viewed in a Visit. |
| pagetime | A timestamp in GMT epoch seconds for a Pageview. |
| pagetitle | The title of Pages viewed during the date range. AGF only. |
| pagetitle:{N} | pagetitle:{N} The title of a Page viewed during a visit. Replace {N} with the page number to retrieve. pagetitle:4 returns the title of the fourth Page viewed in a Visit. |
| pageviewpath:{N} | Returns a specified subdirectory in the path of a Page. pageviewpath:2 for the Page '/part1/part2/part3/index.html' returns 'part2/'. |
INTERNAL SEARCH
| Dimension | Description |
|---|---|
| is_destination | Search Destination: Pages (links) on a Search Results Page that receive clicks. |
| is_exitterm | Search Exit Term: shows the Search Terms associated with Search Exits |
| is_lowresultsterm | Low Results Term: shows Search Terms with a low average number of Search Results |
| is_origin | Search Origin: the Page where the search originates |
| is_refinedterm | Refinement Term: a Search Term whose Origin is a Search Results Page. |
| is_results | Number of Results: shows the number of search results returned for any Search Term. |
| is_term | Search Term: the search terms typed into the internal search function |
| is_usage | Search Usage: identifies Visits that use the internal search function and Visits with no search activity |
| is_vertical | Search Vertical: represents a search index focused on a specific topic, also called a search category. |
| Dimension | Description |
|---|---|
| activeusername | Active Usernames appear on the uploaded Username List, and have one or more Visits during the selected date range. |
| lowactivityusernamemonthly | Low Activity Usernames that have fewer Visits than the Monthly Low Activity # threshold. |
| lowactivityusernameannual | Low Activity Usernames that have fewer Visits than the Annual Low Activity # threshold. |
| inactiveusername | Inactive Usernames appear on the uploaded Username List, and have zero Visits during the selected date range. |
| usernameunknown | Unknown Usernames have one or more Visits during the selected date range, but do not appear on the uploaded Usernames List. |
Hit-Level Dimensions
Hit-level Dimensions are values associated with data in the IT Reports section. Hit data is not sessionized: the Dimensions reflect the data observed in the logs.
| Dimension | Description |
|---|---|
| bldomain | Broken Links: the Linking Domain (Hostname) that contains the broken link. |
| blfilehost | Broken Links: the Hostname that contains the file referenced in the broken link. |
| blfilestem | Broken Links: the File Name referenced in the broken link. |
| blinternalref | Broken Links: the Link Type, can be "Internal" or "External" |
| blreferrer | Broken Links: the referrer (Linking Domain + Referral Page) that contains the broken link. |
| botagent | User Agents that match the Bot Agent Match config setting for the Profile |
| downloadfilehost | Downloads: the hostname for the file downloaded. |
| downloadfilestem | Downloads: the request stem for the file downloaded. |
| downloadfiletype | Downloads: the File Type for the file downloaded |
| downloadhitip | Downloads: the client IP address which downloaded the file. |
| downloadhittime | Downloads: the timestamp in GMT epoch seconds when the file was downloaded. |
| filepath:{N} | A part of a file path. filepath:2 for the File Name '/part1/part2/part3.mp3' returns 'part2/'. |
| filestem | The URI stem of the requested file - shown in the Top Files report & Filename segment. |
| filetype | The File Type | mime type of the hit. Hits with no file type are represented by a dash. |
| hbdatasource | The Datasource name used to process logs in the Profile |
| hbhost | The Hostname(s) observed for hits in the logs. |
| hittime | The hour of day timestamp in GMT epoch seconds for a File Name. |
| ipaddressesip | The IP Addresses observed for hits in the logs. |
| statuscode | The Status Code for web server responses |
| statusdescription | A brief explanation of each Status Code |
| useragent | Shows the full User Agent field observed for hits in the logs. |
Get help for this page
Jitbit HelpDesk