AnalyticsHelper Class

Analytics helper class.

Inheritance Hierarchy

System.Object
  CMS.WebAnalytics.AnalyticsHelper

Namespace: CMS.WebAnalytics
Assembly: CMS.WebAnalytics (in CMS.WebAnalytics.dll) Version: 8.2.23

Syntax

public static class AnalyticsHelper

The AnalyticsHelper type exposes the following members.

Methods

	Name	Description
Public method Static member	AddTrackedCampaign	Adds new campaign to TrackedCampaigns collection. Adding is performed only when campaign is not already present.
Public method Static member	AnalyticsEnabled	Returns true if web analytics is enabled for specified site.
Public method Static member	CampaignTrackingParameter	Returns the campaign tracking URL parameter.
Public method Static member	CurrentCampaign	Returns current request campaign name reference.
Public method Static member	ExcludedFileExtensions	Returns "Excluded file extensions" value from the database.
Public method Static member	ExcludedIPs	Returns "Excluded IPs" value from the database.
Public method Static member	ExcludedURLs	Returns "Excluded URLs" value from the database.
Public method Static member	ExcludeSearchEngines	Returns "Exclude search engines" value from the database.
Public method Static member	GetContextStatus	Returns current visitor status
Public method Static member	GetQueryStringParameters	Generates reports parameters for query string
Public method Static member	GetVisitorStatusByIP	Returns visitor status by IP visit
Public method Static member	GetVisitorStatusIdle	Gets or sets the value in minutes for how long user should be counted as active(1380 minutes by default = 23 hours).
Public method Static member	IsFileExtensionExcluded	Determines whether extension is excluded or not.
Public method Static member	IsIPExcluded	Determines whether IP is excluded or not.
Public method Static member	IsLoggingEnabled(String, String)	Return true if analytics log enabled for given data
Public method Static member	IsLoggingEnabled(String, String, LogExcludingFlags)	Return true if analytics log enabled for given data
Public method Static member	IsSearchEngineExcluded	Returns true if current request is search engine and should be excluded from the analytics log.
Public method Static member	IsURLExcluded	Determines whether URL is excluded or not.
Public method Static member	JavascriptLoggingEnabled	Returns "Use JavaScript logging" value from the database.
Public method Static member	LogAverageTimeOnPage	Logs average time on page
Public method Static member	LogExitPage	Logs exit page
Public method Static member	LogExitPageCandidate	Logs exit page candidate
Public method Static member	LogIPVisit(String, String)	Logs given IP address to the IP table
Public method Static member	LogIPVisit(String, String, DateTime)	Logs given IP address to the IP table
Public method Static member	LogLandingPage	Logs landing page.
Public method Static member	LogOnSiteSearchKeywords	Logs onsite search keywords.
Public method Static member	LogReferringSite	Track traffic sources (used by search engines, direct url, inner site links..).
Public method Static member	LogRegisteredUser	Logs registered user to the statistics.
Public method Static member	LogSearchCrawler	Logs crawler visits
Public method Static member	LogSearchKeywords	Logs keywords.
Public method Static member	RemoveTrackedCampaigns	Removes TrackedCampaign cookie from cookie collection.
Public method Static member	SetCampaign	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 method Static member	SetContextStatus	Sets context status.
Public method Static member	TrackAggregatedViewsEnabled	Returns true if aggregated views tracking is enabled for specified site.
Public method Static member	TrackAverageTimeOnPage	Returns true if average time on page tracking is enabled
Public method Static member	TrackBrowserTypesEnabled	Returns true if browser types tracking is enabled for specified site.
Public method Static member	TrackCampaignsEnabled	Returns true if campaigns tracking is enabled for specified site.
Public method Static member	TrackConversionsEnabled	Returns true if conversions tracking is enabled for specified site.
Public method Static member	TrackCountriesEnabled	Returns true if countries tracking is enabled for specified site.
Public method Static member	TrackExitPageEnabled	Returns true if exit page tracking is enabled for specific site.
Public method Static member	TrackFileDownloadsEnabled	Returns true if file downloads tracking is enabled for specified site.
Public method Static member	TrackInvalidPagesEnabled	Returns true if invalid pages tracking is enabled for specified site.
Public method Static member	TrackLandingPageEnabled	Returns true if landing page tracking is enabled for specific site.
Public method Static member	TrackMobileDevicesEnabled	Returns true if mobile device tracking is enabled
Public method Static member	TrackOnSiteKeywords	Returns true if onsite keywords tracking is enabled for specified site.
Public method Static member	TrackPageViewsEnabled	Returns true if page views tracking is enabled for specified site.
Public method Static member	TrackReferralsEnabled	Returns true if referrals tracking is enabled for specified site.
Public method Static member	TrackReferringSitesDirect	Returns true if referring sites direct link tracking is enabled for specified site.
Public method Static member	TrackReferringSitesLocal	Returns true if referring sites by local links tracking is enabled for specified site.
Public method Static member	TrackReferringSitesReferring	Returns true if referring sites by other domain tracking is enabled for specific site.
Public method Static member	TrackRegisteredUserConversion	Tracks registered user conversion.
Public method Static member	TrackRegisteredUsersEnabled	Returns true if registered users tracking is enabled for specified site.
Public method Static member	TrackSearchCrawlersEnabled	Returns true if search crawlers tracking is enabled for specific site.
Public method Static member	TrackSearchEnginesEnabled	Returns true if search engine tracking is enabled for specific site.
Public method Static member	TrackSearchKeywordsEnabled	Returns true if search keywords tracking is enabled for specific site.
Public method Static member	TrackUserRegistration	Logs user registration into the web analytics and if conversion name and value are set, the conversion is tracked.
Public method Static member	TrackVisitsEnabled	Returns true if visits tracking is enabled for specified site.
Public method Static member	VisitorsSmartCheckingTime	Returns how long should be visitors' IP addresses stored in memory. Visitors smart checking is disabled if 0 is returned.

Fields

	Name	Description
Public field Static member	MANAGE_WINDOW_HEIGHT	Height of manage data window
Public field Static member	MANAGE_WINDOW_WIDTH	Width of manage data window
Public field Static member	PARAM_SEMICOLON	Replacement for the semicolon character used in the url parameter
Public field Static member	SUBSCRIPTION_WINDOW_HEIGHT	Height of subscription window
Public field Static member	SUBSCRIPTION_WINDOW_WIDTH	Width of subscription window

Properties

	Name	Description
Public property Static member	Campaign	Gets or sets the current campaign
Public property Static member	EnableAutomaticCampaignCreate	Gets or sets the value that indicates whether automatic campaign creation is enabled
Public property Static member	Referrer	Replaceable referrer (checks "AnalyticsReferrerString" item in RequestStockHelper first).
Public property Static member	RemoveReferralQuery	Returns true, if query string should be removed from the referral URL; otherwise, false.
Public property Static member	SlidingIPExpiration	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 property Static member	TrackedCampaigns	Gets enumerable of campaigns which should be logged in web analytics service called by Javascript.
Public property Static member	VisitorStatus	Returns visitor status.