All the data in Matomo is available through simple APIs. This plugin is the web-service entry point, that you can call to get your web analytics data in XML, JSON, PHP, CSV, etc.
More info about the Matomo APIs available in Introduction to Matomo API and the Matomo API Reference.
If you want to request data within a script, a crontab, etc. you need to add the 'token_auth
' URL parameter to the API calls for URLs that require authentication. Learn more
You can manage your authentication tokens on your security page.
API
Actions
Annotations
Contents
CoreAdminHome
CorePluginsAdmin
CustomDimensions
CustomJsTracker
Dashboard
DevicePlugins
DevicesDetection
Events
Feedback
Goals
ImageGraph
Insights
LanguagesManager
Live
Login
Marketplace
MobileMessaging
MultiSites
Overlay
PagePerformance
PrivacyManager
Referrers
Resolution
SEO
ScheduledReports
SegmentEditor
SitesManager
Tour
Transitions
TwoFactorAuth
UserCountry
UserId
UserLanguage
UsersManager
VisitFrequency
VisitTime
VisitorInterest
VisitsSummary
Actions
Annotations
Contents
CoreAdminHome
CorePluginsAdmin
CustomDimensions
CustomJsTracker
Dashboard
DevicePlugins
DevicesDetection
Events
Feedback
Goals
ImageGraph
Insights
LanguagesManager
Live
Login
Marketplace
MobileMessaging
MultiSites
Overlay
PagePerformance
PrivacyManager
Referrers
Resolution
SEO
ScheduledReports
SegmentEditor
SitesManager
Tour
Transitions
TwoFactorAuth
UserCountry
UserId
UserLanguage
UsersManager
VisitFrequency
VisitTime
VisitorInterest
VisitsSummary
- API.getMatomoVersion () [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getPhpVersion () [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getPiwikVersion () [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getIpFromHeader () [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getSettings () [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getAvailableMeasurableTypes () [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getSegmentsMetadata (idSites = 'Array') [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getMetadata (idSite, apiModule, apiAction, apiParameters = 'Array', language = '', period = '', date = '', hideMetricsDoc = '', showSubtableReports = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- API.getReportMetadata (idSites = '', period = '', date = '', hideMetricsDoc = '', showSubtableReports = '', idSite = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- API.getProcessedReport (idSite, period, date, apiModule, apiAction, segment = '', apiParameters = '', idGoal = '', language = '', showTimer = '1', hideMetricsDoc = '', idSubtable = '', showRawMetrics = '', format_metrics = '', idDimension = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- API.getReportPagesMetadata (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getWidgetMetadata (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- API.get (idSite, period, date, segment = '', columns = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- API.getRowEvolution (idSite, period, date, apiModule, apiAction, label = '', segment = '', column = '', language = '', idGoal = '', legendAppendMetric = '1', labelUseAbsoluteUrl = '1', idDimension = '', labelSeries = '', showGoalMetricsForGoal = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- API.getBulkRequest (urls) [ No example available ]
- API.isPluginActivated (pluginName) [ No example available ]
- API.getSuggestedValuesForSegment (segmentName, idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getPagesComparisonsDisabledFor () [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getGlossaryReports (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- API.getGlossaryMetrics (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- API.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- API.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- API.setSingletonInstance (instance) [ No example available ]
- Actions.get (idSite, period, date, segment = '', columns = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getPageUrls (idSite, period, date, segment = '', expanded = '', idSubtable = '', depth = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getPageUrlsFollowingSiteSearch (idSite, period, date, segment = '', expanded = '', idSubtable = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getPageTitlesFollowingSiteSearch (idSite, period, date, segment = '', expanded = '', idSubtable = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getEntryPageUrls (idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getExitPageUrls (idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getPageUrl (pageUrl, idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getPageTitles (idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getEntryPageTitles (idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getExitPageTitles (idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getPageTitle (pageName, idSite, period, date, segment = '') [ No example available ]
- Actions.getDownloads (idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getDownload (downloadUrl, idSite, period, date, segment = '') [ No example available ]
- Actions.getOutlinks (idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getOutlink (outlinkUrl, idSite, period, date, segment = '') [ No example available ]
- Actions.getSiteSearchKeywords (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getSiteSearchNoResultKeywords (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.getSiteSearchCategories (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Actions.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Actions.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Actions.setSingletonInstance (instance) [ No example available ]
- Annotations.add (idSite, date, note, starred = '0') [ No example available ]
- Annotations.save (idSite, idNote, date = '', note = '', starred = '') [ No example available ]
- Annotations.delete (idSite, idNote) [ No example available ]
- Annotations.deleteAll (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- Annotations.get (idSite, idNote) [ No example available ]
- Annotations.getAll (idSite, date = '', period = 'day', lastN = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Annotations.getAnnotationCountForDates (idSite, date, period, lastN = '', getAnnotationText = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Annotations.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Annotations.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Annotations.setSingletonInstance (instance) [ No example available ]
- Contents.getContentNames (idSite, period, date, segment = '', idSubtable = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Contents.getContentPieces (idSite, period, date, segment = '', idSubtable = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Contents.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Contents.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Contents.setSingletonInstance (instance) [ No example available ]
- CoreAdminHome.runScheduledTasks () [ Example in
XML,
Json,
Tsv (Excel)
]
- CoreAdminHome.setArchiveSettings (enableBrowserTriggerArchiving, todayArchiveTimeToLive) [ No example available ]
- CoreAdminHome.setTrustedHosts (trustedHosts) [ No example available ]
- CoreAdminHome.setBrandingSettings (useCustomLogo) [ No example available ]
- CoreAdminHome.invalidateArchivedReports (idSites, dates, period = '', segment = '', cascadeDown = '') [ No example available ]
- CoreAdminHome.runCronArchiving () [ Example in
XML,
Json,
Tsv (Excel)
]
- CoreAdminHome.deleteAllTrackingFailures () [ Example in
XML,
Json,
Tsv (Excel)
]
- CoreAdminHome.deleteTrackingFailure (idSite, idFailure) [ No example available ]
- CoreAdminHome.getTrackingFailures () [ Example in
XML,
Json,
Tsv (Excel)
]
- CoreAdminHome.archiveReports (idSite, period, date, segment = '', plugin = '', report = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- CoreAdminHome.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- CoreAdminHome.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- CoreAdminHome.setSingletonInstance (instance) [ No example available ]
- CorePluginsAdmin.setSystemSettings (settingValues, passwordConfirmation = '') [ No example available ]
- CorePluginsAdmin.setUserSettings (settingValues) [ No example available ]
- CorePluginsAdmin.getSystemSettings () [ Example in
XML,
Json,
Tsv (Excel)
]
- CorePluginsAdmin.getUserSettings () [ Example in
XML,
Json,
Tsv (Excel)
]
- CorePluginsAdmin.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- CorePluginsAdmin.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- CorePluginsAdmin.setSingletonInstance (instance) [ No example available ]
- CustomDimensions.getCustomDimension (idDimension, idSite, period, date, segment = '', expanded = '', flat = '', idSubtable = '') [ No example available ]
- CustomDimensions.configureNewCustomDimension (idSite, name, scope, active, extractions = 'Array', caseSensitive = '1') [ No example available ]
- CustomDimensions.configureExistingCustomDimension (idDimension, idSite, name, active, extractions = 'Array', caseSensitive = '') [ No example available ]
- CustomDimensions.getConfiguredCustomDimensions (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- CustomDimensions.getConfiguredCustomDimensionsHavingScope (idSite, scope) [ No example available ]
- CustomDimensions.getAvailableScopes (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- CustomDimensions.getAvailableExtractionDimensions () [ Example in
XML,
Json,
Tsv (Excel)
]
- CustomDimensions.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- CustomDimensions.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- CustomDimensions.setSingletonInstance (instance) [ No example available ]
- CustomJsTracker.doesIncludePluginTrackersAutomatically () [ Example in
XML,
Json,
Tsv (Excel)
]
- CustomJsTracker.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- CustomJsTracker.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- CustomJsTracker.setSingletonInstance (instance) [ No example available ]
- Dashboard.getDashboards (login = '', returnDefaultIfEmpty = '1') [ Example in
XML,
Json,
Tsv (Excel)
]
- Dashboard.createNewDashboardForUser (login, dashboardName = '', addDefaultWidgets = '1') [ No example available ]
- Dashboard.removeDashboard (idDashboard, login = '') [ No example available ]
- Dashboard.copyDashboardToUser (idDashboard, copyToUser, dashboardName = '') [ No example available ]
- Dashboard.resetDashboardLayout (idDashboard, login = '') [ No example available ]
- Dashboard.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Dashboard.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Dashboard.setSingletonInstance (instance) [ No example available ]
- DevicePlugins.getPlugin (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- DevicePlugins.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- DevicePlugins.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- DevicePlugins.setSingletonInstance (instance) [ No example available ]
- DevicesDetection.getType (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- DevicesDetection.getBrand (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- DevicesDetection.getModel (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- DevicesDetection.getOsFamilies (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- DevicesDetection.getOsVersions (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- DevicesDetection.getBrowsers (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- DevicesDetection.getBrowserVersions (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- DevicesDetection.getBrowserEngines (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- DevicesDetection.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- DevicesDetection.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- DevicesDetection.setSingletonInstance (instance) [ No example available ]
- Events.getActionToLoadSubtables (apiMethod, secondaryDimension = '') [ No example available ]
- Events.getDefaultSecondaryDimension (apiMethod) [ No example available ]
- Events.getSecondaryDimensions (apiMethod) [ No example available ]
- Events.getCategory (idSite, period, date, segment = '', expanded = '', secondaryDimension = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Events.getAction (idSite, period, date, segment = '', expanded = '', secondaryDimension = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Events.getName (idSite, period, date, segment = '', expanded = '', secondaryDimension = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Events.getActionFromCategoryId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Events.getNameFromCategoryId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Events.getCategoryFromActionId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Events.getNameFromActionId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Events.getActionFromNameId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Events.getCategoryFromNameId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Events.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Events.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Events.setSingletonInstance (instance) [ No example available ]
- Feedback.sendFeedbackForFeature (featureName, like = '', choice = '', message = '') [ No example available ]
- Feedback.sendFeedbackForSurvey (question, message = '') [ No example available ]
- Feedback.updateFeedbackReminderDate () [ Example in
XML,
Json,
Tsv (Excel)
]
- Feedback.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Feedback.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Feedback.setSingletonInstance (instance) [ No example available ]
- Goals.getGoal (idSite, idGoal) [ No example available ]
- Goals.getGoals (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- Goals.addGoal (idSite, name, matchAttribute, pattern, patternType, caseSensitive = '', revenue = '', allowMultipleConversionsPerVisit = '', description = '', useEventValueAsRevenue = '') [ No example available ]
- Goals.updateGoal (idSite, idGoal, name, matchAttribute, pattern, patternType, caseSensitive = '', revenue = '', allowMultipleConversionsPerVisit = '', description = '', useEventValueAsRevenue = '') [ No example available ]
- Goals.deleteGoal (idSite, idGoal) [ No example available ]
- Goals.getItemsSku (idSite, period, date, abandonedCarts = '', segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.getItemsName (idSite, period, date, abandonedCarts = '', segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.getItemsCategory (idSite, period, date, abandonedCarts = '', segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.get (idSite, period, date, segment = '', idGoal = '', columns = 'Array', showAllGoalSpecificMetrics = '', compare = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.getMetrics (idSite, period, date, segment = '', idGoal = '', columns = 'Array', showAllGoalSpecificMetrics = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.getConversions (idSite, period, date, segment = '', idGoal = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.getNbVisitsConverted (idSite, period, date, segment = '', idGoal = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.getConversionRate (idSite, period, date, segment = '', idGoal = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.getRevenue (idSite, period, date, segment = '', idGoal = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.getDaysToConversion (idSite, period, date, segment = '', idGoal = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.getVisitsUntilConversion (idSite, period, date, segment = '', idGoal = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Goals.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Goals.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Goals.setSingletonInstance (instance) [ No example available ]
- ImageGraph.get (idSite, period, date, apiModule, apiAction, graphType = '', outputType = '0', columns = '', labels = '', showLegend = '1', width = '', height = '', fontSize = '9', legendFontSize = '', aliasedGraph = '1', idGoal = '', colors = '', textColor = '222222', backgroundColor = 'FFFFFF', gridColor = 'CCCCCC', idSubtable = '', legendAppendMetric = '1', segment = '', idDimension = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- ImageGraph.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- ImageGraph.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- ImageGraph.setSingletonInstance (instance) [ No example available ]
- Insights.canGenerateInsights (date, period) [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Insights.getInsightsOverview (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Insights.getMoversAndShakersOverview (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Insights.getMoversAndShakers (idSite, period, date, reportUniqueId, segment = '', comparedToXPeriods = '1', limitIncreaser = '4', limitDecreaser = '4') [ No example available ]
- Insights.getInsights (idSite, period, date, reportUniqueId, segment = '', limitIncreaser = '5', limitDecreaser = '5', filterBy = '', minImpactPercent = '2', minGrowthPercent = '20', comparedToXPeriods = '1', orderBy = 'absolute') [ No example available ]
- Insights.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Insights.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Insights.setSingletonInstance (instance) [ No example available ]
- LanguagesManager.isLanguageAvailable (languageCode) [ Example in
XML,
Json,
Tsv (Excel)
]
- LanguagesManager.getAvailableLanguages () [ Example in
XML,
Json,
Tsv (Excel)
]
- LanguagesManager.getAvailableLanguagesInfo (excludeNonCorePlugins = '1') [ Example in
XML,
Json,
Tsv (Excel)
]
- LanguagesManager.getAvailableLanguageNames () [ Example in
XML,
Json,
Tsv (Excel)
]
- LanguagesManager.getTranslationsForLanguage (languageCode) [ Example in
XML,
Json,
Tsv (Excel)
]
- LanguagesManager.getPluginTranslationsForLanguage (pluginName, languageCode) [ No example available ]
- LanguagesManager.getLanguageForUser (login) [ No example available ]
- LanguagesManager.setLanguageForUser (login, languageCode) [ No example available ]
- LanguagesManager.uses12HourClockForUser (login) [ No example available ]
- LanguagesManager.set12HourClockForUser (login, use12HourClock) [ No example available ]
- LanguagesManager.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- LanguagesManager.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- LanguagesManager.setSingletonInstance (instance) [ No example available ]
- Live.getCounters (idSite, lastMinutes, segment = '', showColumns = 'Array', hideColumns = 'Array') [ Example in
XML,
Json,
Tsv (Excel)
]
- Live.getLastVisitsDetails (idSite, period = '', date = '', segment = '', countVisitorsToFetch = '', minTimestamp = '', flat = '', doNotFetchActions = '', enhanced = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Live.getVisitorProfile (idSite, visitorId = '', segment = '', limitVisits = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- Live.getMostRecentVisitorId (idSite, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- Live.getFirstVisitForVisitorId (idSite, visitorId) [ No example available ]
- Live.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Live.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Live.setSingletonInstance (instance) [ No example available ]
- Login.unblockBruteForceIPs () [ Example in
XML,
Json,
Tsv (Excel)
]
- Login.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Login.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Login.setSingletonInstance (instance) [ No example available ]
- Marketplace.deleteLicenseKey () [ No example available ]
- Marketplace.saveLicenseKey (licenseKey) [ No example available ]
- Marketplace.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Marketplace.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Marketplace.setSingletonInstance (instance) [ No example available ]
- MobileMessaging.areSMSAPICredentialProvided () [ Example in
XML,
Json,
Tsv (Excel)
]
- MobileMessaging.getSMSProvider () [ Example in
XML,
Json,
Tsv (Excel)
]
- MobileMessaging.setSMSAPICredential (provider, credentials = 'Array') [ No example available ]
- MobileMessaging.addPhoneNumber (phoneNumber) [ No example available ]
- MobileMessaging.getCreditLeft () [ Example in
XML,
Json,
Tsv (Excel)
]
- MobileMessaging.removePhoneNumber (phoneNumber) [ No example available ]
- MobileMessaging.validatePhoneNumber (phoneNumber, verificationCode) [ No example available ]
- MobileMessaging.deleteSMSAPICredential () [ Example in
XML,
Json,
Tsv (Excel)
]
- MobileMessaging.setDelegatedManagement (delegatedManagement) [ No example available ]
- MobileMessaging.getDelegatedManagement () [ Example in
XML,
Json,
Tsv (Excel)
]
- MobileMessaging.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- MobileMessaging.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- MobileMessaging.setSingletonInstance (instance) [ No example available ]
- MultiSites.getAll (period, date, segment = '', enhanced = '', pattern = '', showColumns = 'Array') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- MultiSites.getOne (idSite, period, date, segment = '', enhanced = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- MultiSites.getApiMetrics (enhanced) [ No example available ]
- MultiSites.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- MultiSites.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- MultiSites.setSingletonInstance (instance) [ No example available ]
- Overlay.getTranslations (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- Overlay.getExcludedQueryParameters (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- Overlay.getFollowingPages (url, idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Overlay.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Overlay.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Overlay.setSingletonInstance (instance) [ No example available ]
- PagePerformance.get (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- PagePerformance.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- PagePerformance.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- PagePerformance.setSingletonInstance (instance) [ No example available ]
- PrivacyManager.deleteDataSubjects (visits) [ No example available ]
- PrivacyManager.exportDataSubjects (visits) [ No example available ]
- PrivacyManager.findDataSubjects (idSite, segment) [ No example available ]
- PrivacyManager.anonymizeSomeRawData (idSites, date, anonymizeIp = '', anonymizeLocation = '', anonymizeUserId = '', unsetVisitColumns = 'Array', unsetLinkVisitActionColumns = 'Array') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- PrivacyManager.getAvailableVisitColumnsToAnonymize () [ Example in
XML,
Json,
Tsv (Excel)
]
- PrivacyManager.getAvailableLinkVisitActionColumnsToAnonymize () [ Example in
XML,
Json,
Tsv (Excel)
]
- PrivacyManager.setAnonymizeIpSettings (anonymizeIPEnable, maskLength, useAnonymizedIpForVisitEnrichment, anonymizeUserId = '', anonymizeOrderId = '', anonymizeReferrer = '', forceCookielessTracking = '') [ No example available ]
- PrivacyManager.deactivateDoNotTrack () [ Example in
XML,
Json,
Tsv (Excel)
]
- PrivacyManager.activateDoNotTrack () [ Example in
XML,
Json,
Tsv (Excel)
]
- PrivacyManager.setScheduleReportDeletionSettings (deleteLowestInterval = '7') [ Example in
XML,
Json,
Tsv (Excel)
]
- PrivacyManager.setDeleteLogsSettings (enableDeleteLogs = '0', deleteLogsOlderThan = '180') [ Example in
XML,
Json,
Tsv (Excel)
]
- PrivacyManager.setDeleteReportsSettings (enableDeleteReports = '0', deleteReportsOlderThan = '3', keepBasic = '0', keepDay = '0', keepWeek = '0', keepMonth = '0', keepYear = '0', keepRange = '0', keepSegments = '0') [ Example in
XML,
Json,
Tsv (Excel)
]
- PrivacyManager.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- PrivacyManager.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- PrivacyManager.setSingletonInstance (instance) [ No example available ]
- Referrers.get (idSite, period, date, segment = '', columns = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getReferrerType (idSite, period, date, segment = '', typeReferrer = '', idSubtable = '', expanded = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getAll (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getKeywords (idSite, period, date, segment = '', expanded = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getKeywordNotDefinedString () [ Example in
XML,
Json,
Tsv (Excel)
]
- Referrers.getCleanKeyword (label) [ Example in
XML,
Json,
Tsv (Excel)
]
- Referrers.getSearchEnginesFromKeywordId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Referrers.getSearchEngines (idSite, period, date, segment = '', expanded = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getKeywordsFromSearchEngineId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Referrers.getCampaigns (idSite, period, date, segment = '', expanded = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getKeywordsFromCampaignId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Referrers.getWebsites (idSite, period, date, segment = '', expanded = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getUrlsFromWebsiteId (idSite, period, date, idSubtable, segment = '') [ No example available ]
- Referrers.getSocials (idSite, period, date, segment = '', expanded = '', flat = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getUrlsForSocial (idSite, period, date, segment = '', idSubtable = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getNumberOfDistinctSearchEngines (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getNumberOfDistinctSocialNetworks (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getNumberOfDistinctKeywords (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getNumberOfDistinctCampaigns (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getNumberOfDistinctWebsites (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.getNumberOfDistinctWebsitesUrls (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Referrers.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Referrers.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Referrers.setSingletonInstance (instance) [ No example available ]
- Resolution.getResolution (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Resolution.getConfiguration (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Resolution.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Resolution.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Resolution.setSingletonInstance (instance) [ No example available ]
- SEO.getRank (url) [ Example in
XML,
Json,
Tsv (Excel)
]
- SEO.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- SEO.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- SEO.setSingletonInstance (instance) [ No example available ]
- ScheduledReports.addReport (idSite, description, period, hour, reportType, reportFormat, reports, parameters, idSegment = '', evolutionPeriodFor = 'prev', evolutionPeriodN = '', periodParam = '') [ No example available ]
- ScheduledReports.updateReport (idReport, idSite, description, period, hour, reportType, reportFormat, reports, parameters, idSegment = '', evolutionPeriodFor = 'prev', evolutionPeriodN = '', periodParam = '') [ No example available ]
- ScheduledReports.deleteReport (idReport) [ No example available ]
- ScheduledReports.getReports (idSite = '', period = '', idReport = '', ifSuperUserReturnOnlySuperUserReports = '', idSegment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- ScheduledReports.generateReport (idReport, date, language = '', outputType = '', period = '', reportFormat = '', parameters = '') [ No example available ]
- ScheduledReports.sendReport (idReport, period = '', date = '', force = '') [ No example available ]
- ScheduledReports.getReportMetadata (idSite, reportType) [ No example available ]
- ScheduledReports.allowMultipleReports (reportType) [ No example available ]
- ScheduledReports.getReportTypes () [ Example in
XML,
Json,
Tsv (Excel)
]
- ScheduledReports.getReportFormats (reportType) [ No example available ]
- ScheduledReports.getReportRecipients (report) [ No example available ]
- ScheduledReports.getSegment (idSegment) [ No example available ]
- ScheduledReports.isSegmentEditorActivated () [ Example in
XML,
Json,
Tsv (Excel)
]
- ScheduledReports.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- ScheduledReports.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- ScheduledReports.setSingletonInstance (instance) [ No example available ]
- SegmentEditor.isUserCanAddNewSegment (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- SegmentEditor.delete (idSegment) [ No example available ]
- SegmentEditor.update (idSegment, name, definition, idSite = '', autoArchive = '', enabledAllUsers = '') [ No example available ]
- SegmentEditor.add (name, definition, idSite = '', autoArchive = '', enabledAllUsers = '') [ No example available ]
- SegmentEditor.get (idSegment) [ No example available ]
- SegmentEditor.getAll (idSite = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- SegmentEditor.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- SegmentEditor.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- SegmentEditor.setSingletonInstance (instance) [ No example available ]
- SitesManager.getJavascriptTag (idSite, piwikUrl = '', mergeSubdomains = '', groupPageTitlesByDomain = '', mergeAliasUrls = '', visitorCustomVariables = '', pageCustomVariables = '', customCampaignNameQueryParam = '', customCampaignKeywordParam = '', doNotTrack = '', disableCookies = '', trackNoScript = '', crossDomain = '', forceMatomoEndpoint = '', excludedQueryParams = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getImageTrackingCode (idSite, piwikUrl = '', actionName = '', idGoal = '', revenue = '', forceMatomoEndpoint = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesFromGroup (group = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesGroups () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSiteFromId (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSiteUrlsFromId (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getAllSites () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getAllSitesId () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesWithAdminAccess (fetchAliasUrls = '', pattern = '', limit = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesWithViewAccess () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesWithAtLeastViewAccess (limit = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesIdWithAdminAccess () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesIdWithViewAccess () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesIdWithWriteAccess () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesIdWithAtLeastViewAccess () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesIdFromSiteUrl (url) [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSitesIdFromTimezones (timezones) [ No example available ]
- SitesManager.addSite (siteName, urls = '', ecommerce = '', siteSearch = '', searchKeywordParameters = '', searchCategoryParameters = '', excludedIps = '', excludedQueryParameters = '', timezone = '', currency = '', group = '', startDate = '', excludedUserAgents = '', keepURLFragments = '', type = '', settingValues = '', excludeUnknownUrls = '') [ No example available ]
- SitesManager.getSiteSettings (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.deleteSite (idSite) [ No example available ]
- SitesManager.addSiteAliasUrls (idSite, urls) [ No example available ]
- SitesManager.setSiteAliasUrls (idSite, urls = 'Array') [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getIpsForRange (ipRange) [ No example available ]
- SitesManager.setGlobalExcludedIps (excludedIps) [ No example available ]
- SitesManager.setGlobalSearchParameters (searchKeywordParameters, searchCategoryParameters) [ No example available ]
- SitesManager.getSearchKeywordParametersGlobal () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getSearchCategoryParametersGlobal () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getExcludedQueryParametersGlobal () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getExcludedUserAgentsGlobal () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.setGlobalExcludedUserAgents (excludedUserAgents) [ No example available ]
- SitesManager.getKeepURLFragmentsGlobal () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.setKeepURLFragmentsGlobal (enabled) [ No example available ]
- SitesManager.setGlobalExcludedQueryParameters (excludedQueryParameters) [ No example available ]
- SitesManager.getExcludedIpsGlobal () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getDefaultCurrency () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.setDefaultCurrency (defaultCurrency) [ No example available ]
- SitesManager.getDefaultTimezone () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.setDefaultTimezone (defaultTimezone) [ No example available ]
- SitesManager.updateSite (idSite, siteName = '', urls = '', ecommerce = '', siteSearch = '', searchKeywordParameters = '', searchCategoryParameters = '', excludedIps = '', excludedQueryParameters = '', timezone = '', currency = '', group = '', startDate = '', excludedUserAgents = '', keepURLFragments = '', type = '', settingValues = '', excludeUnknownUrls = '') [ No example available ]
- SitesManager.updateSiteCreatedTime (idSites, minDate) [ No example available ]
- SitesManager.getCurrencyList () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getCurrencySymbols () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.isTimezoneSupportEnabled () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getTimezonesList () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.getTimezoneName (timezone, countryCode = '', multipleTimezonesInCountry = '') [ No example available ]
- SitesManager.getUniqueSiteTimezones () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.renameGroup (oldGroupName, newGroupName) [ No example available ]
- SitesManager.getPatternMatchSites (pattern, limit = '') [ No example available ]
- SitesManager.getNumWebsitesToDisplayPerPage () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- SitesManager.setSingletonInstance (instance) [ No example available ]
- Tour.getChallenges () [ Example in
XML,
Json,
Tsv (Excel)
]
- Tour.skipChallenge (id) [ No example available ]
- Tour.getLevel () [ Example in
XML,
Json,
Tsv (Excel)
]
- Tour.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Tour.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Tour.setSingletonInstance (instance) [ No example available ]
- Transitions.getTransitionsForPageTitle (pageTitle, idSite, period, date, segment = '', limitBeforeGrouping = '') [ No example available ]
- Transitions.getTransitionsForPageUrl (pageUrl, idSite, period, date, segment = '', limitBeforeGrouping = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Transitions.getTransitionsForAction (actionName, actionType, idSite, period, date, segment = '', limitBeforeGrouping = '', parts = 'all') [ No example available ]
- Transitions.getTranslations () [ Example in
XML,
Json,
Tsv (Excel)
]
- Transitions.isPeriodAllowed (idSite, period, date) [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- Transitions.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- Transitions.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- Transitions.setSingletonInstance (instance) [ No example available ]
- TwoFactorAuth.resetTwoFactorAuth (userLogin, passwordConfirmation) [ No example available ]
- TwoFactorAuth.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- TwoFactorAuth.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- TwoFactorAuth.setSingletonInstance (instance) [ No example available ]
- UserCountry.getCountry (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- UserCountry.getContinent (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- UserCountry.getRegion (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- UserCountry.getCity (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- UserCountry.getCountryCodeMapping () [ Example in
XML,
Json,
Tsv (Excel)
]
- UserCountry.getLocationFromIP (ip = '', provider = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- UserCountry.setLocationProvider (providerId) [ No example available ]
- UserCountry.getNumberOfDistinctCountries (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- UserCountry.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- UserCountry.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- UserCountry.setSingletonInstance (instance) [ No example available ]
- UserId.getUsers (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- UserId.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- UserId.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- UserId.setSingletonInstance (instance) [ No example available ]
- UserLanguage.getLanguage (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- UserLanguage.getLanguageCode (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- UserLanguage.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- UserLanguage.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- UserLanguage.setSingletonInstance (instance) [ No example available ]
- UsersManager.getAvailableRoles () [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getAvailableCapabilities () [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.setUserPreference (userLogin, preferenceName, preferenceValue) [ No example available ]
- UsersManager.getUserPreference (preferenceName, userLogin = '') [ No example available ]
- UsersManager.initUserPreferenceWithDefault (userLogin, preferenceName) [ No example available ]
- UsersManager.getAllUsersPreferences (preferenceNames) [ No example available ]
- UsersManager.getUsersPlusRole (idSite, limit = '', offset = '0', filter_search = '', filter_access = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getUsers (userLogins = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getUsersLogin () [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getUsersSitesFromAccess (access) [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getUsersAccessFromSite (idSite) [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getUsersWithSiteAccess (idSite, access) [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getSitesAccessFromUser (userLogin) [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getSitesAccessForUser (userLogin, limit = '', offset = '0', filter_search = '', filter_access = '') [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getUser (userLogin) [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getUserByEmail (userEmail) [ No example available ]
- UsersManager.addUser (userLogin, password, email, initialIdSite = '') [ No example available ]
- UsersManager.setSuperUserAccess (userLogin, hasSuperUserAccess, passwordConfirmation = '') [ No example available ]
- UsersManager.hasSuperUserAccess () [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.getUsersHavingSuperUserAccess () [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.updateUser (userLogin, password = '', email = '', passwordConfirmation = '') [ No example available ]
- UsersManager.deleteUser (userLogin) [ No example available ]
- UsersManager.userExists (userLogin) [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.userEmailExists (userEmail) [ No example available ]
- UsersManager.getUserLoginFromUserEmail (userEmail) [ No example available ]
- UsersManager.setUserAccess (userLogin, access, idSites) [ No example available ]
- UsersManager.addCapabilities (userLogin, capabilities, idSites) [ No example available ]
- UsersManager.removeCapabilities (userLogin, capabilities, idSites) [ No example available ]
- UsersManager.createAppSpecificTokenAuth (userLogin, passwordConfirmation, description, expireDate = '', expireHours = '0') [ No example available ]
- UsersManager.newsletterSignup () [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- UsersManager.setSingletonInstance (instance) [ No example available ]
- VisitFrequency.get (idSite, period, date, segment = '', columns = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitFrequency.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- VisitFrequency.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- VisitFrequency.setSingletonInstance (instance) [ No example available ]
- VisitTime.getVisitInformationPerLocalTime (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitTime.getVisitInformationPerServerTime (idSite, period, date, segment = '', hideFutureHoursWhenToday = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitTime.getByDayOfWeek (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitTime.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- VisitTime.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- VisitTime.setSingletonInstance (instance) [ No example available ]
- VisitorInterest.getNumberOfVisitsPerVisitDuration (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitorInterest.getNumberOfVisitsPerPage (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitorInterest.getNumberOfVisitsByDaysSinceLast (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitorInterest.getNumberOfVisitsByVisitCount (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitorInterest.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- VisitorInterest.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- VisitorInterest.setSingletonInstance (instance) [ No example available ]
- VisitsSummary.get (idSite, period, date, segment = '', columns = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.getVisits (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.getUniqueVisitors (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.getUsers (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.getActions (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.getMaxActions (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.getBounceCount (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.getVisitsConverted (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.getSumVisitsLength (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.getSumVisitsLengthPretty (idSite, period, date, segment = '') [ Example in
XML,
Json,
Tsv (Excel)
, RSS of the last 10 days
]
- VisitsSummary.unsetInstance () [ Example in
XML,
Json,
Tsv (Excel)
]
- VisitsSummary.unsetAllInstances () [ Example in
XML,
Json,
Tsv (Excel)
]
- VisitsSummary.setSingletonInstance (instance) [ No example available ]