Click or drag to resize
AnalyticsHelper Class
Analytics helper class.
Inheritance Hierarchy
SystemObject
  CMS.WebAnalyticsAnalyticsHelper

Namespace: CMS.WebAnalytics
Assembly: CMS.WebAnalytics (in CMS.WebAnalytics.dll) Version: 8.2.23
Syntax
C#
public static class AnalyticsHelper

The AnalyticsHelper type exposes the following members.

Methods
  NameDescription
Public methodStatic memberAddTrackedCampaign
Adds new campaign to TrackedCampaigns collection. Adding is performed only when campaign is not already present.
Public methodStatic memberAnalyticsEnabled
Returns true if web analytics is enabled for specified site.
Public methodStatic memberCampaignTrackingParameter
Returns the campaign tracking URL parameter.
Public methodStatic memberCurrentCampaign
Returns current request campaign name reference.
Public methodStatic memberExcludedFileExtensions
Returns "Excluded file extensions" value from the database.
Public methodStatic memberExcludedIPs
Returns "Excluded IPs" value from the database.
Public methodStatic memberExcludedURLs
Returns "Excluded URLs" value from the database.
Public methodStatic memberExcludeSearchEngines
Returns "Exclude search engines" value from the database.
Public methodStatic memberGetContextStatus
Returns current visitor status
Public methodStatic memberGetQueryStringParameters
Generates reports parameters for query string
Public methodStatic memberGetVisitorStatusByIP
Returns visitor status by IP visit
Public methodStatic memberGetVisitorStatusIdle
Gets or sets the value in minutes for how long user should be counted as active(1380 minutes by default = 23 hours).
Public methodStatic memberIsFileExtensionExcluded
Determines whether extension is excluded or not.
Public methodStatic memberIsIPExcluded
Determines whether IP is excluded or not.
Public methodStatic memberIsLoggingEnabled(String, String)
Return true if analytics log enabled for given data
Public methodStatic memberIsLoggingEnabled(String, String, LogExcludingFlags)
Return true if analytics log enabled for given data
Public methodStatic memberIsSearchEngineExcluded
Returns true if current request is search engine and should be excluded from the analytics log.
Public methodStatic memberIsURLExcluded
Determines whether URL is excluded or not.
Public methodStatic memberJavascriptLoggingEnabled
Returns "Use JavaScript logging" value from the database.
Public methodStatic memberLogAverageTimeOnPage
Logs average time on page
Public methodStatic memberLogExitPage
Logs exit page
Public methodStatic memberLogExitPageCandidate
Logs exit page candidate
Public methodStatic memberLogIPVisit(String, String)
Logs given IP address to the IP table
Public methodStatic memberLogIPVisit(String, String, DateTime)
Logs given IP address to the IP table
Public methodStatic memberLogLandingPage
Logs landing page.
Public methodStatic memberLogOnSiteSearchKeywords
Logs onsite search keywords.
Public methodStatic memberLogReferringSite
Track traffic sources (used by search engines, direct url, inner site links..).
Public methodStatic memberLogRegisteredUser
Logs registered user to the statistics.
Public methodStatic memberLogSearchCrawler
Logs crawler visits
Public methodStatic memberLogSearchKeywords
Logs keywords.
Public methodStatic memberRemoveTrackedCampaigns
Removes TrackedCampaign cookie from cookie collection.
Public methodStatic memberSetCampaign
Creates log with current campaign or write campaign into cookie, if Javascript logging is enabled. Cookie will be used for logging using web analytics service.
Public methodStatic memberSetContextStatus
Sets context status.
Public methodStatic memberTrackAggregatedViewsEnabled
Returns true if aggregated views tracking is enabled for specified site.
Public methodStatic memberTrackAverageTimeOnPage
Returns true if average time on page tracking is enabled
Public methodStatic memberTrackBrowserTypesEnabled
Returns true if browser types tracking is enabled for specified site.
Public methodStatic memberTrackCampaignsEnabled
Returns true if campaigns tracking is enabled for specified site.
Public methodStatic memberTrackConversionsEnabled
Returns true if conversions tracking is enabled for specified site.
Public methodStatic memberTrackCountriesEnabled
Returns true if countries tracking is enabled for specified site.
Public methodStatic memberTrackExitPageEnabled
Returns true if exit page tracking is enabled for specific site.
Public methodStatic memberTrackFileDownloadsEnabled
Returns true if file downloads tracking is enabled for specified site.
Public methodStatic memberTrackInvalidPagesEnabled
Returns true if invalid pages tracking is enabled for specified site.
Public methodStatic memberTrackLandingPageEnabled
Returns true if landing page tracking is enabled for specific site.
Public methodStatic memberTrackMobileDevicesEnabled
Returns true if mobile device tracking is enabled
Public methodStatic memberTrackOnSiteKeywords
Returns true if onsite keywords tracking is enabled for specified site.
Public methodStatic memberTrackPageViewsEnabled
Returns true if page views tracking is enabled for specified site.
Public methodStatic memberTrackReferralsEnabled
Returns true if referrals tracking is enabled for specified site.
Public methodStatic memberTrackReferringSitesDirect
Returns true if referring sites direct link tracking is enabled for specified site.
Public methodStatic memberTrackReferringSitesLocal
Returns true if referring sites by local links tracking is enabled for specified site.
Public methodStatic memberTrackReferringSitesReferring
Returns true if referring sites by other domain tracking is enabled for specific site.
Public methodStatic memberTrackRegisteredUserConversion
Tracks registered user conversion.
Public methodStatic memberTrackRegisteredUsersEnabled
Returns true if registered users tracking is enabled for specified site.
Public methodStatic memberTrackSearchCrawlersEnabled
Returns true if search crawlers tracking is enabled for specific site.
Public methodStatic memberTrackSearchEnginesEnabled
Returns true if search engine tracking is enabled for specific site.
Public methodStatic memberTrackSearchKeywordsEnabled
Returns true if search keywords tracking is enabled for specific site.
Public methodStatic memberTrackUserRegistration
Logs user registration into the web analytics and if conversion name and value are set, the conversion is tracked.
Public methodStatic memberTrackVisitsEnabled
Returns true if visits tracking is enabled for specified site.
Public methodStatic memberVisitorsSmartCheckingTime
Returns how long should be visitors' IP addresses stored in memory. Visitors smart checking is disabled if 0 is returned.
Top
Fields
  NameDescription
Public fieldStatic memberMANAGE_WINDOW_HEIGHT
Height of manage data window
Public fieldStatic memberMANAGE_WINDOW_WIDTH
Width of manage data window
Public fieldStatic memberPARAM_SEMICOLON
Replacement for the semicolon character used in the url parameter
Public fieldStatic memberSUBSCRIPTION_WINDOW_HEIGHT
Height of subscription window
Public fieldStatic memberSUBSCRIPTION_WINDOW_WIDTH
Width of subscription window
Top
Properties
  NameDescription
Public propertyStatic memberCampaign
Gets or sets the current campaign
Public propertyStatic memberEnableAutomaticCampaignCreate
Gets or sets the value that indicates whether automatic campaign creation is enabled
Public propertyStatic memberReferrer
Replaceable referrer (checks "AnalyticsReferrerString" item in RequestStockHelper first).
Public propertyStatic memberRemoveReferralQuery
Returns true, if query string should be removed from the referral URL; otherwise, false.
Public propertyStatic memberSlidingIPExpiration
Returns true if IP for anonymous visitor should be logged every time. Returns false if IP should be logged only once per user visit.
Public propertyStatic memberTrackedCampaigns
Gets enumerable of campaigns which should be logged in web analytics service called by Javascript.
Public propertyStatic memberVisitorStatus
Returns visitor status.
Top
See Also