API Matomo : toutes les méthodes de l’API de reporting

Matomo expose la totalité de ses données via une API HTTP : tout ce que vous lisez dans l'interface peut être récupéré en JSON, XML, CSV ou directement en image. Cette page recense l'ensemble des méthodes disponibles, module par module, avec leurs paramètres — ce que la documentation officielle disperse sur plusieurs dizaines de pages.

58modules
531méthodes
4formats de sortie

Comment appeler l'API Matomo

Tous les appels passent par un point d'entrée unique, index.php, avec module=API et le nom de la méthode voulue :

https://votre-matomo.example/index.php?module=API
    &method=VisitsSummary.get
    &idSite=1
    &period=day
    &date=yesterday
    &format=JSON
    &token_auth=VOTRE_JETON

Les paramètres qui reviennent partout :

  • method — le module et la méthode, par exemple Actions.getPageUrls.
  • idSite — l'identifiant du site mesuré. Plusieurs sites : idSite=1,2,3, ou all pour tous.
  • periodday, week, month, year ou range.
  • datetoday, yesterday, une date AAAA-MM-JJ, ou une plage 2026-01-01,2026-01-31 avec period=range.
  • formatJSON, XML, CSV, TSV ou HTML.
  • segment — un segment appliqué à la volée, par exemple segment=countryCode==fr;deviceType==smartphone.
  • token_auth — le jeton d'authentification, à créer depuis Administration > Personnel > Sécurité. À transmettre en POST plutôt qu'en paramètre d'URL dès que possible : une URL se retrouve dans les journaux serveur.

Dans les signatures ci-dessous, un paramètre affiché en noir est obligatoire ; un paramètre en gris, accompagné de sa valeur par défaut, est facultatif.

Les 58 modules

AbTesting18 méthodes

Gestion des tests A/B : création, démarrage, arrêt et archivage des expérimentations, récupération des résultats par métrique de succès.

  • AbTesting.getMetricsOverview(idSite, period, date, idExperiment, segment = '')
  • AbTesting.getMetricDetails(idSite, period, date, idExperiment, successMetric, segment = '')
  • AbTesting.addExperiment(idSite, name, hypothesis, description, variations, includedTargets, successMetrics)
  • AbTesting.updateExperiment(idExperiment, idSite, name, description, hypothesis, variations, confidenceThreshold, mdeRelative, percentageParticipants, successMetrics, includedTargets, excludedTargets = 'Array', startDate = '', endDate = '')
  • AbTesting.startExperiment(idExperiment, idSite)
  • AbTesting.finishExperiment(idExperiment, idSite)
  • AbTesting.archiveExperiment(idExperiment, idSite)
  • AbTesting.getJsIncludeTemplate()
  • AbTesting.getJsExperimentTemplate(idExperiment, idSite)
  • AbTesting.getAllExperiments(idSite)
  • AbTesting.getActiveExperiments(idSite)
  • AbTesting.getExperimentsByStatuses(idSite, statuses)
  • AbTesting.getExperiment(idExperiment, idSite)
  • AbTesting.deleteExperiment(idExperiment, idSite)
  • AbTesting.getAvailableStatuses(idSite)
  • AbTesting.getAvailableSuccessMetrics(idSite)
  • AbTesting.getAvailableTargetAttributes()
  • AbTesting.getExperimentsWithReports(idSite)
↑ haut de page

Actions18 méthodes

Tout ce que fait le visiteur sur le site : URL et titres de pages, événements, contenus, téléchargements, clics sortants, recherche interne. Les paramètres pageName, pageUrl, outlinkUrl et downloadUrl doivent être encodés avant l'appel.

  • Actions.get(idSite, period, date, segment = '', columns = '')
  • Actions.getPageUrls(idSite, period, date, segment = '', expanded = '', idSubtable = '', depth = '', flat = '')
  • Actions.getPageUrlsFollowingSiteSearch(idSite, period, date, segment = '', expanded = '', idSubtable = '')
  • Actions.getPageTitlesFollowingSiteSearch(idSite, period, date, segment = '', expanded = '', idSubtable = '')
  • Actions.getEntryPageUrls(idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '')
  • Actions.getExitPageUrls(idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '')
  • Actions.getPageUrl(pageUrl, idSite, period, date, segment = '')
  • Actions.getPageTitles(idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '')
  • Actions.getEntryPageTitles(idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '')
  • Actions.getExitPageTitles(idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '')
  • Actions.getPageTitle(pageName, idSite, period, date, segment = '')
  • Actions.getDownloads(idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '')
  • Actions.getDownload(downloadUrl, idSite, period, date, segment = '')
  • Actions.getOutlinks(idSite, period, date, segment = '', expanded = '', idSubtable = '', flat = '')
  • Actions.getOutlink(outlinkUrl, idSite, period, date, segment = '')
  • Actions.getSiteSearchKeywords(idSite, period, date, segment = '')
  • Actions.getSiteSearchNoResultKeywords(idSite, period, date, segment = '')
  • Actions.getSiteSearchCategories(idSite, period, date, segment = '')
↑ haut de page

ActivityLog2 méthodes

Journal d'activité des utilisateurs de l'instance : connexions, échecs de connexion, déconnexions, création ou modification d'utilisateurs, de sites, de rapports programmés et de segments. Un Super User voit tous les utilisateurs, les autres ne voient que leur propre activité.

  • ActivityLog.getEntries(offset = '0', limit = '25', filterByUserLogin = '', filterByActivityType = '')
  • ActivityLog.getEntryCount(filterByUserLogin = '', filterByActivityType = '')
↑ haut de page

AdvertisingConversionExport6 méthodes

Export des conversions vers les régies publicitaires, et gestion des exports configurés par site.

  • AdvertisingConversionExport.getConversionExports(idSite = '')
  • AdvertisingConversionExport.getConversionExport(idExport)
  • AdvertisingConversionExport.deleteConversionExport(idExport, idSite)
  • AdvertisingConversionExport.addConversionExport(idSite, name, type, parameters, description = '')
  • AdvertisingConversionExport.regenerateAccessToken(idExport)
  • AdvertisingConversionExport.updateConversionExport(idExport, idSite, name, type, parameters, description = '')
↑ haut de page

Annotations7 méthodes

Annotations posées sur les graphiques : ajout, modification, suppression et lecture des notes datées attachées à un site.

  • Annotations.add(idSite, date, note, starred = '0')
  • Annotations.save(idSite, idNote, date = '', note = '', starred = '')
  • Annotations.delete(idSite, idNote)
  • Annotations.deleteAll(idSite)
  • Annotations.get(idSite, idNote)
  • Annotations.getAll(idSite, date = '', period = 'day', lastN = '')
  • Annotations.getAnnotationCountForDates(idSite, date, period, lastN = '', getAnnotationText = '')
↑ haut de page

API18 méthodes

Le module méta : il décrit toutes les autres API. Liste des méthodes disponibles, métriques renvoyées par chacune, métadonnées des segments. La méthode getProcessedReport renvoie n'importe quel rapport dans une version lisible, métriques calculées comprises (taux de conversion, temps passé).

  • API.getMatomoVersion()
  • API.getPhpVersion()
  • API.getIpFromHeader()
  • API.getSettings()
  • API.getSegmentsMetadata(idSites = 'Array')
  • API.getMetadata(idSite, apiModule, apiAction, apiParameters = 'Array', language = '', period = '', date = '', hideMetricsDoc = '', showSubtableReports = '')
  • API.getReportMetadata(idSites = '', period = '', date = '', hideMetricsDoc = '', showSubtableReports = '', idSite = '')
  • API.getProcessedReport(idSite, period, date, apiModule, apiAction, segment = '', apiParameters = '', idGoal = '', language = '', showTimer = '1', hideMetricsDoc = '', idSubtable = '', showRawMetrics = '', format_metrics = '', idDimension = '')
  • API.getReportPagesMetadata(idSite)
  • API.getWidgetMetadata(idSite)
  • API.get(idSite, period, date, segment = '', columns = '')
  • API.getRowEvolution(idSite, period, date, apiModule, apiAction, label = '', segment = '', column = '', language = '', idGoal = '', legendAppendMetric = '1', labelUseAbsoluteUrl = '1', idDimension = '', labelSeries = '', showGoalMetricsForGoal = '')
  • API.getBulkRequest(urls)
  • API.isPluginActivated(pluginName)
  • API.getSuggestedValuesForSegment(segmentName, idSite)
  • API.getPagesComparisonsDisabledFor()
  • API.getGlossaryReports(idSite)
  • API.getGlossaryMetrics(idSite)
↑ haut de page

ConnectAccounts3 méthodes

Rattachement de comptes tiers à l'instance Matomo.

  • ConnectAccounts.getGtmContainersList(string accountId)
  • ConnectAccounts.getGtmWorkspaceList(string accountId, string containerId)
  • ConnectAccounts.createMatomoTag(string accountId, string containerId, string workspaceId, array parentInfo)
↑ haut de page

Contents2 méthodes

Suivi des contenus (Content Tracking) : noms de contenus affichés et éléments avec lesquels le visiteur a interagi, pour mesurer impressions et clics sur des blocs d'une page.

  • Contents.getContentNames(idSite, period, date, segment = '', idSubtable = '')
  • Contents.getContentPieces(idSite, period, date, segment = '', idSubtable = '')
↑ haut de page

CoreAdminHome3 méthodes

Opérations d'administration de l'instance, dont le déclenchement de l'archivage et l'invalidation de rapports déjà archivés.

  • CoreAdminHome.deleteAllTrackingFailures()
  • CoreAdminHome.deleteTrackingFailure(idSite, idFailure)
  • CoreAdminHome.getTrackingFailures()
↑ haut de page

CrashAnalytics32 méthodes

Suivi des erreurs JavaScript : liste des crashs, types de crashs, crashs ignorés, résumé d'un crash, contexte de visite ayant précédé l'erreur, évolution dans le temps.

  • CrashAnalytics.searchCrashMessagesForMerge(idSite, resourceUri = '', searchTerm = '', limit = '10', offset = '0', excludeIdLogCrashes = 'Array')
  • CrashAnalytics.mergeCrashes(idSite, idLogCrashes)
  • CrashAnalytics.unmergeCrashGroup(idSite, idLogCrash)
  • CrashAnalytics.getCrashGroups(idSite)
  • CrashAnalytics.getCrashTypes(idSite, filter_limit = '')
  • CrashAnalytics.setIgnoreCrash(idSite, idLogCrash, ignore = '1')
  • CrashAnalytics.getIgnoredCrashes(idSite)
  • CrashAnalytics.getCrashSummary(idSite, idLogCrash)
  • CrashAnalytics.getCrashVisitContext(idLogCrash, idSite, period, date, segment = '', filter_limit = '5', filter_offset = '0', fetchRecentActions = '1')
  • CrashAnalytics.getAllCrashes(idSite, filter_sort_column = 'datetime_last_seen', filter_sort_order = 'desc', filter_limit = '10', filter_offset = '0')
  • CrashAnalytics.get(idSite, period, date, segment = '', columns = '')
  • CrashAnalytics.getAllCrashMessages(idSite, period, date, segment = '')
  • CrashAnalytics.getCrashMessages(idSite, period, date, segment = '')
  • CrashAnalytics.getUnidentifiedCrashMessages(idSite, period, date, segment = '')
  • CrashAnalytics.getDisappearedCrashes(idSite, period, date, segment = '')
  • CrashAnalytics.getReappearedCrashes(idSite, period, date, segment = '')
  • CrashAnalytics.getNewCrashes(idSite, period, date, segment = '')
  • CrashAnalytics.getCrashesByPageUrl(idSite, period, date, segment = '', expanded = '', flat = '')
  • CrashAnalytics.getCrashesForPageUrl(idSite, period, date, idSubtable, segment = '')
  • CrashAnalytics.getCrashesByPageTitle(idSite, period, date, segment = '', expanded = '', flat = '')
  • CrashAnalytics.getCrashesForPageTitle(idSite, period, date, idSubtable, segment = '')
  • CrashAnalytics.getCrashesBySource(idSite, period, date, segment = '', expanded = '', flat = '')
  • CrashAnalytics.getCrashesForSource(idSite, period, date, idSubtable, segment = '')
  • CrashAnalytics.getCrashesByCategory(idSite, period, date, segment = '', expanded = '', flat = '')
  • CrashAnalytics.getCrashesForCategory(idSite, period, date, idSubtable, segment = '')
  • CrashAnalytics.getCrashesByFirstParty(idSite, period, date, segment = '')
  • CrashAnalytics.getCrashesByThirdParty(idSite, period, date, segment = '')
  • CrashAnalytics.getLastCrashesOverview(idSite, segment = '', lastMinutes = '30')
  • CrashAnalytics.getLastTopCrashes(idSite, segment = '', lastMinutes = '30', filter_limit = '5')
  • CrashAnalytics.getLastNewCrashes(idSite, segment = '', lastMinutes = '30', filter_limit = '10')
  • CrashAnalytics.getLastReappearedCrashes(idSite, segment = '', lastMinutes = '30', filter_limit = '10')
  • CrashAnalytics.getLastDisappearedCrashes(idSite, segment = '', lastMinutes = '30', filter_limit = '10')
↑ haut de page

CustomAlerts7 méthodes

Alertes personnalisées : création, édition et suppression de règles déclenchant une notification quand une métrique franchit un seuil.

  • CustomAlerts.getValuesForAlertInPast(idAlert, subPeriodN)
  • CustomAlerts.getAlert(idAlert)
  • CustomAlerts.getAlerts(idSites, ifSuperUserReturnAllAlerts = '')
  • CustomAlerts.addAlert(name, idSites, period, emailMe, additionalEmails, phoneNumbers, metric, metricCondition, metricValue, comparedTo, reportUniqueId, reportCondition = '', reportValue = '')
  • CustomAlerts.editAlert(idAlert, name, idSites, period, emailMe, additionalEmails, phoneNumbers, metric, metricCondition, metricValue, comparedTo, reportUniqueId, reportCondition = '', reportValue = '')
  • CustomAlerts.deleteAlert(idAlert)
  • CustomAlerts.getTriggeredAlerts(idSites)
↑ haut de page

CustomDimensions7 méthodes

Dimensions personnalisées, au niveau visite ou action : configuration, activation et lecture des rapports associés.

  • CustomDimensions.getCustomDimension(idDimension, idSite, period, date, segment = '', expanded = '', flat = '', idSubtable = '')
  • CustomDimensions.configureNewCustomDimension(idSite, name, scope, active, extractions = 'Array', caseSensitive = '1')
  • CustomDimensions.configureExistingCustomDimension(idDimension, idSite, name, active, extractions = 'Array', caseSensitive = '')
  • CustomDimensions.getConfiguredCustomDimensions(idSite)
  • CustomDimensions.getConfiguredCustomDimensionsHavingScope(idSite, scope)
  • CustomDimensions.getAvailableScopes(idSite)
  • CustomDimensions.getAvailableExtractionDimensions()
↑ haut de page

CustomJsTracker1 méthode

Récupération du fichier JavaScript de suivi personnalisé généré par l'instance.

  • CustomJsTracker.doesIncludePluginTrackersAutomatically()
↑ haut de page

CustomReports10 méthodes

Rapports personnalisés : construction de rapports sur mesure en croisant dimensions et métriques, et lecture de leurs résultats.

  • CustomReports.addCustomReport(idSite, name, reportType, metricIds, categoryId = '', dimensionIds = 'Array', subcategoryId = '', description = '', segmentFilter = '')
  • CustomReports.updateCustomReport(idSite, idCustomReport, name, reportType, metricIds, categoryId = '', dimensionIds = 'Array', subcategoryId = '', description = '', segmentFilter = '')
  • CustomReports.getConfiguredReports(idSite, skipCategoryMetadata = '')
  • CustomReports.getConfiguredReport(idSite, idCustomReport)
  • CustomReports.deleteCustomReport(idSite, idCustomReport)
  • CustomReports.getAvailableCategories(idSite)
  • CustomReports.getAvailableReportTypes()
  • CustomReports.getAvailableDimensions(idSite)
  • CustomReports.getAvailableMetrics(idSite)
  • CustomReports.getCustomReport(idSite, period, date, idCustomReport, segment = '', expanded = '', flat = '', idSubtable = '', columns = '')
↑ haut de page

CustomVariables3 méthodes

Variables personnalisées (mécanisme historique, remplacé par les dimensions personnalisées).

  • CustomVariables.getCustomVariables(idSite, period, date, segment = '', expanded = '', flat = '')
  • CustomVariables.getCustomVariablesValuesFromNameId(idSite, period, date, idSubtable, segment = '')
  • CustomVariables.getUsagesOfSlots(idSite)
↑ haut de page

Dashboard5 méthodes

Tableaux de bord : liste des tableaux d'un utilisateur et gestion de leur contenu.

  • Dashboard.getDashboards(login = '', returnDefaultIfEmpty = '1')
  • Dashboard.createNewDashboardForUser(login, dashboardName = '', addDefaultWidgets = '1')
  • Dashboard.removeDashboard(idDashboard, login = '')
  • Dashboard.copyDashboardToUser(idDashboard, copyToUser, dashboardName = '')
  • Dashboard.resetDashboardLayout(idDashboard, login = '')
↑ haut de page

DevicePlugins1 méthode

Plugins détectés dans le navigateur du visiteur.

  • DevicePlugins.getPlugin(idSite, period, date, segment = '')
↑ haut de page

DevicesDetection8 méthodes

Matériel et logiciel du visiteur : type d'appareil, marque, modèle, système d'exploitation, navigateur et moteur de rendu.

  • DevicesDetection.getType(idSite, period, date, segment = '')
  • DevicesDetection.getBrand(idSite, period, date, segment = '')
  • DevicesDetection.getModel(idSite, period, date, segment = '')
  • DevicesDetection.getOsFamilies(idSite, period, date, segment = '')
  • DevicesDetection.getOsVersions(idSite, period, date, segment = '')
  • DevicesDetection.getBrowsers(idSite, period, date, segment = '')
  • DevicesDetection.getBrowserVersions(idSite, period, date, segment = '')
  • DevicesDetection.getBrowserEngines(idSite, period, date, segment = '')
↑ haut de page

Events9 méthodes

Événements traqués : catégories, actions et noms d'événements, avec la possibilité de descendre d'un niveau à l'autre et de choisir la dimension secondaire.

  • Events.getCategory(idSite, period, date, segment = '', expanded = '', secondaryDimension = '', flat = '')
  • Events.getAction(idSite, period, date, segment = '', expanded = '', secondaryDimension = '', flat = '')
  • Events.getName(idSite, period, date, segment = '', expanded = '', secondaryDimension = '', flat = '')
  • Events.getActionFromCategoryId(idSite, period, date, idSubtable, segment = '')
  • Events.getNameFromCategoryId(idSite, period, date, idSubtable, segment = '')
  • Events.getCategoryFromActionId(idSite, period, date, idSubtable, segment = '')
  • Events.getNameFromActionId(idSite, period, date, idSubtable, segment = '')
  • Events.getActionFromNameId(idSite, period, date, idSubtable, segment = '')
  • Events.getCategoryFromNameId(idSite, period, date, idSubtable, segment = '')
↑ haut de page

Feedback3 méthodes

Envoi de retours vers Matomo depuis l'interface.

  • Feedback.sendFeedbackForFeature(featureName, like = '', choice = '', message = '')
  • Feedback.sendFeedbackForSurvey(question, message = '')
  • Feedback.updateFeedbackReminderDate()
↑ haut de page

FormAnalytics24 méthodes

Analyse des formulaires : taux de conversion, champs abandonnés, temps passé par champ, évolution et détails par formulaire.

  • FormAnalytics.addForm(idSite, name, description = '', matchFormRules = '', matchPageRules = '', conversionRuleOption = 'page_visit', conversionRules = '')
  • FormAnalytics.updateForm(idSite, idForm, name, description = '', matchFormRules = '', matchPageRules = '', conversionRuleOption = 'page_visit', conversionRules = '')
  • FormAnalytics.getForm(idSite, idForm)
  • FormAnalytics.getForms(idSite)
  • FormAnalytics.getFormsByStatuses(idSite, statuses)
  • FormAnalytics.deleteForm(idSite, idForm)
  • FormAnalytics.archiveForm(idSite, idForm)
  • FormAnalytics.get(idSite, period, date, idForm = '', segment = '', columns = '')
  • FormAnalytics.getEntryFields(idSite, period, date, idForm, segment = '')
  • FormAnalytics.getDropOffFields(idSite, period, date, idForm, segment = '')
  • FormAnalytics.getPageUrls(idSite, period, date, idForm, segment = '')
  • FormAnalytics.getFieldTimings(idSite, period, date, idForm, segment = '')
  • FormAnalytics.getFieldSize(idSite, period, date, idForm, segment = '')
  • FormAnalytics.getUneededFields(idSite, period, date, idForm, segment = '')
  • FormAnalytics.getMostUsedFields(idSite, period, date, idForm, segment = '')
  • FormAnalytics.getFieldCorrections(idSite, period, date, idForm, segment = '')
  • FormAnalytics.updateFormFieldDisplayName(idSite, idForm, fields = 'Array')
  • FormAnalytics.getCounters(idSite, lastMinutes, segment = '')
  • FormAnalytics.getCurrentMostPopularForms(idSite, lastMinutes, filter_limit = '5', segment = '')
  • FormAnalytics.getAutoCreationSettings(idSite)
  • FormAnalytics.getAvailableStatuses()
  • FormAnalytics.getAvailableFormRules()
  • FormAnalytics.getAvailablePageRules()
  • FormAnalytics.getAvailableConversionRuleOptions()
↑ haut de page

Funnels11 méthodes

Tunnels de conversion : définition des étapes, taux de passage entre étapes et points de sortie.

  • Funnels.getMetrics(idSite, period, date, idFunnel = '', idGoal = '', segment = '')
  • Funnels.getFunnelFlow(idSite, period, date, idFunnel = '', idGoal = '', segment = '')
  • Funnels.getFunnelEntries(idSite, period, date, idFunnel, segment = '', step = '', expanded = '', idSubtable = '', flat = '')
  • Funnels.getFunnelExits(idSite, period, date, idFunnel, segment = '', step = '')
  • Funnels.getGoalFunnel(idSite, idGoal)
  • Funnels.getAllActivatedFunnelsForSite(idSite)
  • Funnels.hasAnyActivatedFunnelForSite(idSite)
  • Funnels.deleteGoalFunnel(idSite, idGoal)
  • Funnels.setGoalFunnel(idSite, idGoal, isActivated, steps)
  • Funnels.getAvailablePatternMatches()
  • Funnels.testUrlMatchesSteps(url, steps)
↑ haut de page

Goals11 méthodes

Objectifs et conversions : création et gestion des objectifs, rapports de conversion, attribution du chiffre d'affaires et analyse par dimension.

  • Goals.getGoal(idSite, idGoal)
  • Goals.getGoals(idSite)
  • Goals.addGoal(idSite, name, matchAttribute, pattern, patternType, caseSensitive = '', revenue = '', allowMultipleConversionsPerVisit = '', description = '', useEventValueAsRevenue = '')
  • Goals.updateGoal(idSite, idGoal, name, matchAttribute, pattern, patternType, caseSensitive = '', revenue = '', allowMultipleConversionsPerVisit = '', description = '', useEventValueAsRevenue = '')
  • Goals.deleteGoal(idSite, idGoal)
  • Goals.getItemsSku(idSite, period, date, abandonedCarts = '', segment = '')
  • Goals.getItemsName(idSite, period, date, abandonedCarts = '', segment = '')
  • Goals.getItemsCategory(idSite, period, date, abandonedCarts = '', segment = '')
  • Goals.get(idSite, period, date, segment = '', idGoal = '', columns = 'Array', showAllGoalSpecificMetrics = '', compare = '')
  • Goals.getDaysToConversion(idSite, period, date, segment = '', idGoal = '')
  • Goals.getVisitsUntilConversion(idSite, period, date, segment = '', idGoal = '')
↑ haut de page

HeatmapSessionRecording31 méthodes

Cartes de chaleur et enregistrements de session : gestion des campagnes, récupération des heatmaps de clic, de survol et de défilement, et lecture des sessions enregistrées.

  • HeatmapSessionRecording.addHeatmap(idSite, name, matchPageRules, sampleLimit = '1000', sampleRate = '5', excludedElements = '', screenshotUrl = '', breakpointMobile = '', breakpointTablet = '', captureDomManually = '')
  • HeatmapSessionRecording.updateHeatmap(idSite, idSiteHsr, name, matchPageRules, sampleLimit = '1000', sampleRate = '5', excludedElements = '', screenshotUrl = '', breakpointMobile = '', breakpointTablet = '', captureDomManually = '')
  • HeatmapSessionRecording.deleteHeatmapScreenshot(idSite, idSiteHsr)
  • HeatmapSessionRecording.addSessionRecording(idSite, name, matchPageRules = 'Array', sampleLimit = '1000', sampleRate = '10', minSessionTime = '0', requiresActivity = '1', captureKeystrokes = '1')
  • HeatmapSessionRecording.updateSessionRecording(idSite, idSiteHsr, name, matchPageRules = 'Array', sampleLimit = '1000', sampleRate = '10', minSessionTime = '0', requiresActivity = '1', captureKeystrokes = '1')
  • HeatmapSessionRecording.getHeatmap(idSite, idSiteHsr)
  • HeatmapSessionRecording.getSessionRecording(idSite, idSiteHsr)
  • HeatmapSessionRecording.pauseHeatmap(idSite, idSiteHsr)
  • HeatmapSessionRecording.resumeHeatmap(idSite, idSiteHsr)
  • HeatmapSessionRecording.deleteHeatmap(idSite, idSiteHsr)
  • HeatmapSessionRecording.endHeatmap(idSite, idSiteHsr)
  • HeatmapSessionRecording.pauseSessionRecording(idSite, idSiteHsr)
  • HeatmapSessionRecording.resumeSessionRecording(idSite, idSiteHsr)
  • HeatmapSessionRecording.deleteSessionRecording(idSite, idSiteHsr)
  • HeatmapSessionRecording.endSessionRecording(idSite, idSiteHsr)
  • HeatmapSessionRecording.getHeatmaps(idSite, includePageTreeMirror = '1')
  • HeatmapSessionRecording.getSessionRecordings(idSite)
  • HeatmapSessionRecording.getRecordedSessions(idSite, period, date, idSiteHsr, segment = '', idSubtable = '')
  • HeatmapSessionRecording.getRecordedSession(idSite, idSiteHsr, idLogHsr)
  • HeatmapSessionRecording.deleteRecordedSession(idSite, idSiteHsr, idVisit)
  • HeatmapSessionRecording.deleteRecordedPageview(idSite, idSiteHsr, idLogHsr)
  • HeatmapSessionRecording.getRecordedHeatmapMetadata(idSite, period, date, idSiteHsr, segment = '')
  • HeatmapSessionRecording.getRecordedHeatmap(idSite, period, date, idSiteHsr, heatmapType, deviceType, segment = '')
  • HeatmapSessionRecording.getEmbedSessionInfo(idSite, idSiteHsr, idLogHsr)
  • HeatmapSessionRecording.testUrlMatchPages(url, matchPageRules = 'Array')
  • HeatmapSessionRecording.getAvailableStatuses()
  • HeatmapSessionRecording.getAvailableTargetPageRules()
  • HeatmapSessionRecording.getAvailableDeviceTypes()
  • HeatmapSessionRecording.getAvailableHeatmapTypes()
  • HeatmapSessionRecording.getAvailableSessionRecordingSampleLimits()
  • HeatmapSessionRecording.getEventTypes()
↑ haut de page

ImageGraph1 méthode

Génération de graphiques au format image (PNG), utilisable pour insérer un rapport Matomo dans un e-mail ou un document.

  • 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 = '')
↑ haut de page

Insights5 méthodes

Détection automatique des variations notables d'un rapport entre deux périodes : ce qui a le plus progressé, le plus reculé, ce qui apparaît et ce qui disparaît.

  • Insights.canGenerateInsights(date, period)
  • Insights.getInsightsOverview(idSite, period, date, segment = '')
  • Insights.getMoversAndShakersOverview(idSite, period, date, segment = '')
  • Insights.getMoversAndShakers(idSite, period, date, reportUniqueId, segment = '', comparedToXPeriods = '1', limitIncreaser = '4', limitDecreaser = '4')
  • Insights.getInsights(idSite, period, date, reportUniqueId, segment = '', limitIncreaser = '5', limitDecreaser = '5', filterBy = '', minImpactPercent = '2', minGrowthPercent = '20', comparedToXPeriods = '1', orderBy = 'absolute')
↑ haut de page

LanguagesManager9 méthodes

Langues disponibles dans l'interface et langue choisie par un utilisateur.

  • LanguagesManager.isLanguageAvailable(languageCode)
  • LanguagesManager.getAvailableLanguages()
  • LanguagesManager.getAvailableLanguagesInfo(excludeNonCorePlugins = '1')
  • LanguagesManager.getAvailableLanguageNames()
  • LanguagesManager.getTranslationsForLanguage(languageCode)
  • LanguagesManager.getLanguageForUser(login)
  • LanguagesManager.setLanguageForUser(login, languageCode)
  • LanguagesManager.uses12HourClockForUser(login)
  • LanguagesManager.set12HourClockForUser(login, use12HourClock)
↑ haut de page

Live4 méthodes

Données en temps réel : derniers visiteurs, détail complet de leurs visites action par action, profil d'un visiteur et compteur de visiteurs en ligne.

  • Live.getCounters(idSite, int lastMinutes, segment = '', showColumns = 'Array', hideColumns = 'Array')
  • Live.getLastVisitsDetails(idSite, period = '', date = '', segment = '', countVisitorsToFetch = '', minTimestamp = '', flat = '', doNotFetchActions = '', enhanced = '')
  • Live.getVisitorProfile(idSite, visitorId = '', segment = '', limitVisits = '')
  • Live.getMostRecentVisitorId(idSite, segment = '')
↑ haut de page

Login1 méthode

Opérations liées à l'authentification.

  • Login.unblockBruteForceIPs()
↑ haut de page

MarketingCampaignsReporting11 méthodes

Rapports de campagnes marketing détaillés : nom, source, support, mot-clé, groupe et contenu de campagne, avec les combinaisons entre ces dimensions.

  • MarketingCampaignsReporting.getId(idSite, period, date, segment = '')
  • MarketingCampaignsReporting.getName(idSite, period, date, segment = '', expanded = '')
  • MarketingCampaignsReporting.getKeywordContentFromNameId(idSite, period, date, idSubtable, segment = '')
  • MarketingCampaignsReporting.getKeyword(idSite, period, date, segment = '')
  • MarketingCampaignsReporting.getSource(idSite, period, date, segment = '')
  • MarketingCampaignsReporting.getMedium(idSite, period, date, segment = '')
  • MarketingCampaignsReporting.getContent(idSite, period, date, segment = '')
  • MarketingCampaignsReporting.getGroup(idSite, period, date, segment = '')
  • MarketingCampaignsReporting.getPlacement(idSite, period, date, segment = '')
  • MarketingCampaignsReporting.getSourceMedium(idSite, period, date, segment = '', expanded = '')
  • MarketingCampaignsReporting.getNameFromSourceMediumId(idSite, period, date, idSubtable, segment = '')
↑ haut de page

MediaAnalytics15 méthodes

Analyse des lectures vidéo et audio : nombre de lectures, temps de visionnage, taux d'achèvement, audience en temps réel et rapports par média.

  • MediaAnalytics.hasRecords(idSite)
  • MediaAnalytics.get(idSite, period, date, segment = '', columns = '')
  • MediaAnalytics.getCurrentNumPlays(idSite, lastMinutes, segment = '')
  • MediaAnalytics.getCurrentSumTimeSpent(idSite, lastMinutes, segment = '')
  • MediaAnalytics.getCurrentMostPlays(idSite, lastMinutes, filter_limit = '5', segment = '')
  • MediaAnalytics.getVideoResources(idSite, period, date, segment = '', idSubtable = '', secondaryDimension = '', expanded = '', flat = '')
  • MediaAnalytics.getAudioResources(idSite, period, date, segment = '', idSubtable = '', secondaryDimension = '', expanded = '', flat = '')
  • MediaAnalytics.getVideoTitles(idSite, period, date, segment = '', idSubtable = '', secondaryDimension = '')
  • MediaAnalytics.getAudioTitles(idSite, period, date, segment = '', idSubtable = '', secondaryDimension = '')
  • MediaAnalytics.getGroupedVideoResources(idSite, period, date, segment = '', idSubtable = '', secondaryDimension = '')
  • MediaAnalytics.getGroupedAudioResources(idSite, period, date, segment = '', idSubtable = '', secondaryDimension = '')
  • MediaAnalytics.getVideoHours(idSite, period, date, segment = '')
  • MediaAnalytics.getAudioHours(idSite, period, date, segment = '')
  • MediaAnalytics.getVideoResolutions(idSite, period, date, segment = '')
  • MediaAnalytics.getPlayers(idSite, period, date, segment = '')
↑ haut de page

MobileMessaging10 méthodes

Envoi de rapports par SMS : configuration du fournisseur, gestion des numéros de téléphone et validation.

  • MobileMessaging.areSMSAPICredentialProvided()
  • MobileMessaging.getSMSProvider()
  • MobileMessaging.setSMSAPICredential(provider, credentials = 'Array')
  • MobileMessaging.addPhoneNumber(phoneNumber)
  • MobileMessaging.getCreditLeft()
  • MobileMessaging.removePhoneNumber(phoneNumber)
  • MobileMessaging.validatePhoneNumber(phoneNumber, verificationCode)
  • MobileMessaging.deleteSMSAPICredential()
  • MobileMessaging.setDelegatedManagement(delegatedManagement)
  • MobileMessaging.getDelegatedManagement()
↑ haut de page

MultiChannelConversionAttribution5 méthodes

Attribution multi-canal : répartition du mérite d'une conversion entre les différents canaux d'acquisition ayant précédé l'achat.

  • MultiChannelConversionAttribution.setGoalAttribution(idSite, idGoal, isEnabled)
  • MultiChannelConversionAttribution.getGoalAttribution(idSite, idGoal)
  • MultiChannelConversionAttribution.getChannelAttribution(idSite, period, date, idGoal, idCampaignDimensionCombination = '0', segment = '', expanded = '', flat = '', idSubtable = '')
  • MultiChannelConversionAttribution.getAvailableCampaignDimensionCombinations()
  • MultiChannelConversionAttribution.getSiteAttributionGoals(idSite)
↑ haut de page

MultiSites3 méthodes

Vue consolidée de tous les sites de l'instance, avec leurs métriques principales et leur évolution.

  • MultiSites.getAll(period, date, segment = '', enhanced = '', pattern = '', showColumns = 'Array')
  • MultiSites.getOne(idSite, period, date, segment = '', enhanced = '')
  • MultiSites.getAllWithGroups(period = '', date = '', segment = '', pattern = '', filter_limit = '0')
↑ haut de page

Overlay3 méthodes

Données alimentant le Page Overlay, qui superpose les statistiques directement sur le site.

  • Overlay.getTranslations(idSite)
  • Overlay.getExcludedQueryParameters(idSite)
  • Overlay.getFollowingPages(url, idSite, period, date, segment = '')
↑ haut de page

PagePerformance1 méthode

Métriques de performance des pages : temps réseau, serveur, transfert, DOM et temps de chargement total.

  • PagePerformance.get(idSite, period, date, segment = '')
↑ haut de page

PrivacyManager6 méthodes

Respect de la vie privée : anonymisation des données, suppression des données anciennes, export et suppression des données d'une personne sur demande (RGPD).

  • PrivacyManager.deleteDataSubjects(visits)
  • PrivacyManager.exportDataSubjects(visits)
  • PrivacyManager.findDataSubjects(idSite, segment)
  • PrivacyManager.anonymizeSomeRawData(idSites, date, anonymizeIp = '', anonymizeLocation = '', anonymizeUserId = '', unsetVisitColumns = 'Array', unsetLinkVisitActionColumns = 'Array', passwordConfirmation = '')
  • PrivacyManager.getAvailableVisitColumnsToAnonymize()
  • PrivacyManager.getAvailableLinkVisitActionColumnsToAnonymize()
↑ haut de page

Referrers19 méthodes

Sources de trafic : type de référent, moteurs de recherche, mots-clés, sites référents, réseaux sociaux et campagnes.

  • Referrers.get(idSite, period, date, segment = '', columns = '')
  • Referrers.getReferrerType(idSite, period, date, segment = '', typeReferrer = '', idSubtable = '', expanded = '')
  • Referrers.getAll(idSite, period, date, segment = '')
  • Referrers.getKeywords(idSite, period, date, segment = '', expanded = '', flat = '')
  • Referrers.getSearchEnginesFromKeywordId(idSite, period, date, idSubtable, segment = '')
  • Referrers.getSearchEngines(idSite, period, date, segment = '', expanded = '', flat = '')
  • Referrers.getKeywordsFromSearchEngineId(idSite, period, date, idSubtable, segment = '')
  • Referrers.getCampaigns(idSite, period, date, segment = '', expanded = '')
  • Referrers.getKeywordsFromCampaignId(idSite, period, date, idSubtable, segment = '')
  • Referrers.getWebsites(idSite, period, date, segment = '', expanded = '', flat = '')
  • Referrers.getUrlsFromWebsiteId(idSite, period, date, idSubtable, segment = '')
  • Referrers.getSocials(idSite, period, date, segment = '', expanded = '', flat = '')
  • Referrers.getUrlsForSocial(idSite, period, date, segment = '', idSubtable = '')
  • Referrers.getNumberOfDistinctSearchEngines(idSite, period, date, segment = '')
  • Referrers.getNumberOfDistinctSocialNetworks(idSite, period, date, segment = '')
  • Referrers.getNumberOfDistinctKeywords(idSite, period, date, segment = '')
  • Referrers.getNumberOfDistinctCampaigns(idSite, period, date, segment = '')
  • Referrers.getNumberOfDistinctWebsites(idSite, period, date, segment = '')
  • Referrers.getNumberOfDistinctWebsitesUrls(idSite, period, date, segment = '')
↑ haut de page

Resolution2 méthodes

Résolutions d'écran et profondeur de couleur des visiteurs.

  • Resolution.getResolution(idSite, period, date, segment = '')
  • Resolution.getConfiguration(idSite, period, date, segment = '')
↑ haut de page

RollUpReporting3 méthodes

Sites agrégés : création et gestion de sites qui consolident les données de plusieurs autres sites.

  • RollUpReporting.addRollUp(name, sourceIdSites, timezone, currency)
  • RollUpReporting.updateRollUp(idSite, name = '', sourceIdSites = '', timezone = '', currency = '')
  • RollUpReporting.getRollUps()
↑ haut de page

ScheduledReports6 méthodes

Rapports programmés : création, modification, envoi immédiat et génération des rapports envoyés par e-mail ou SMS.

  • ScheduledReports.addReport(idSite, description, period, hour, reportType, reportFormat, reports, parameters, idSegment = '', evolutionPeriodFor = 'prev', evolutionPeriodN = '', periodParam = '')
  • ScheduledReports.updateReport(idReport, idSite, description, period, hour, reportType, reportFormat, reports, parameters, idSegment = '', evolutionPeriodFor = 'prev', evolutionPeriodN = '', periodParam = '')
  • ScheduledReports.deleteReport(idReport)
  • ScheduledReports.getReports(idSite = '', period = '', idReport = '', ifSuperUserReturnOnlySuperUserReports = '', idSegment = '')
  • ScheduledReports.generateReport(idReport, date, language = '', outputType = '', period = '', reportFormat = '', parameters = '')
  • ScheduledReports.sendReport(idReport, period = '', date = '', force = '')
↑ haut de page

SearchEngineKeywordsPerformance12 méthodes

Mots-clés réellement saisis dans les moteurs, importés depuis la Google Search Console, Bing et Yahoo, avec les clics, impressions et positions.

  • SearchEngineKeywordsPerformance.getKeywords(idSite, period, date)
  • SearchEngineKeywordsPerformance.getKeywordsImported(idSite, period, date)
  • SearchEngineKeywordsPerformance.getKeywordsGoogle(idSite, period, date)
  • SearchEngineKeywordsPerformance.getKeywordsBing(idSite, period, date)
  • SearchEngineKeywordsPerformance.getKeywordsYandex(idSite, period, date)
  • SearchEngineKeywordsPerformance.getKeywordsGoogleWeb(idSite, period, date)
  • SearchEngineKeywordsPerformance.getKeywordsGoogleImage(idSite, period, date)
  • SearchEngineKeywordsPerformance.getKeywordsGoogleVideo(idSite, period, date)
  • SearchEngineKeywordsPerformance.getKeywordsGoogleNews(idSite, period, date)
  • SearchEngineKeywordsPerformance.getCrawlingOverviewBing(idSite, period, date)
  • SearchEngineKeywordsPerformance.getCrawlingOverviewYandex(idSite, period, date)
  • SearchEngineKeywordsPerformance.getCrawlingErrorExamplesBing(idSite)
↑ haut de page

SegmentEditor6 méthodes

Segments : création, modification, suppression et lecture des segments enregistrés.

  • SegmentEditor.isUserCanAddNewSegment(idSite)
  • SegmentEditor.delete(idSegment)
  • SegmentEditor.update(idSegment, name, definition, idSite = '', autoArchive = '', enabledAllUsers = '')
  • SegmentEditor.add(name, definition, idSite = '', autoArchive = '', enabledAllUsers = '')
  • SegmentEditor.get(idSegment)
  • SegmentEditor.getAll(idSite = '')
↑ haut de page

SEO1 méthode

Indicateurs SEO d'une URL, récupérés auprès de services externes.

  • SEO.getRank(url)
↑ haut de page

SitesManager50 méthodes

Gestion des sites mesurés : création, modification, suppression, fuseau horaire, devise, URL autorisées, exclusions d'IP, de paramètres d'URL et de user agents, et génération du code de suivi.

  • SitesManager.getJavascriptTag(int idSite, string piwikUrl = '', bool mergeSubdomains = false, bool groupPageTitlesByDomain = false, bool mergeAliasUrls = false, array visitorCustomVariables = 'Array', array pageCustomVariables = 'Array', string customCampaignNameQueryParam = '', string customCampaignKeywordParam = '', bool doNotTrack = false, bool disableCookies = false, bool trackNoScript = false, bool crossDomain = false, bool forceMatomoEndpoint = false, excludedQueryParams = '', excludedReferrers = '')
  • SitesManager.getImageTrackingCode(idSite, piwikUrl = '', actionName = '', idGoal = '', revenue = '', forceMatomoEndpoint = '')
  • SitesManager.getSitesFromGroup(group = '')
  • SitesManager.getSitesGroups()
  • SitesManager.getSiteFromId(idSite)
  • SitesManager.getSiteUrlsFromId(idSite)
  • SitesManager.getAllSites()
  • SitesManager.getAllSitesId()
  • SitesManager.getSitesWithAdminAccess(fetchAliasUrls = '', pattern = '', limit = '', sitesToExclude = 'Array')
  • SitesManager.getSitesWithViewAccess()
  • SitesManager.getSitesWithAtLeastViewAccess(limit = '')
  • SitesManager.getSitesIdWithAdminAccess()
  • SitesManager.getSitesIdWithViewAccess()
  • SitesManager.getSitesIdWithWriteAccess()
  • SitesManager.getSitesIdWithAtLeastViewAccess()
  • SitesManager.getSitesIdFromSiteUrl(url)
  • SitesManager.addSite(siteName, urls = '', ecommerce = '', siteSearch = '', searchKeywordParameters = '', searchCategoryParameters = '', excludedIps = '', excludedQueryParameters = '', timezone = '', currency = '', group = '', startDate = '', excludedUserAgents = '', keepURLFragments = '', type = '', settingValues = '', excludeUnknownUrls = '', excludedReferrers = '')
  • SitesManager.getSiteSettings(idSite)
  • SitesManager.deleteSite(idSite, passwordConfirmation = '')
  • SitesManager.addSiteAliasUrls(idSite, urls)
  • SitesManager.setSiteAliasUrls(idSite, urls = 'Array')
  • SitesManager.getIpsForRange(ipRange)
  • SitesManager.setGlobalExcludedIps(excludedIps)
  • SitesManager.setGlobalSearchParameters(searchKeywordParameters, searchCategoryParameters)
  • SitesManager.getSearchKeywordParametersGlobal()
  • SitesManager.getSearchCategoryParametersGlobal()
  • SitesManager.getExcludedQueryParametersGlobal()
  • SitesManager.getExcludedUserAgentsGlobal()
  • SitesManager.setGlobalExcludedUserAgents(excludedUserAgents)
  • SitesManager.getExcludedReferrers(idSite)
  • SitesManager.getExcludedReferrersGlobal()
  • SitesManager.setGlobalExcludedReferrers(string excludedReferrers)
  • SitesManager.getKeepURLFragmentsGlobal()
  • SitesManager.setKeepURLFragmentsGlobal(enabled)
  • SitesManager.setGlobalExcludedQueryParameters(excludedQueryParameters)
  • SitesManager.getExcludedIpsGlobal()
  • SitesManager.getDefaultCurrency()
  • SitesManager.setDefaultCurrency(defaultCurrency)
  • SitesManager.getDefaultTimezone()
  • SitesManager.setDefaultTimezone(defaultTimezone)
  • SitesManager.updateSite(idSite, siteName = '', urls = '', ecommerce = '', siteSearch = '', searchKeywordParameters = '', searchCategoryParameters = '', excludedIps = '', excludedQueryParameters = '', timezone = '', currency = '', group = '', startDate = '', excludedUserAgents = '', keepURLFragments = '', type = '', settingValues = '', excludeUnknownUrls = '', excludedReferrers = '')
  • SitesManager.getCurrencyList()
  • SitesManager.getCurrencySymbols()
  • SitesManager.isTimezoneSupportEnabled()
  • SitesManager.getTimezonesList()
  • SitesManager.getTimezoneName(timezone, countryCode = '', multipleTimezonesInCountry = '')
  • SitesManager.getUniqueSiteTimezones()
  • SitesManager.renameGroup(oldGroupName, newGroupName)
  • SitesManager.getPatternMatchSites(pattern, limit = '', sitesToExclude = 'Array')
  • SitesManager.getNumWebsitesToDisplayPerPage()
↑ haut de page

TagManager45 méthodes

Matomo Tag Manager : conteneurs, versions, publications, balises, déclencheurs et variables, ainsi que les types disponibles pour chacun.

  • TagManager.getAvailableContexts()
  • TagManager.getAvailableEnvironments()
  • TagManager.getAvailableEnvironmentsWithPublishCapability(idSite)
  • TagManager.getAvailableTagFireLimits()
  • TagManager.getAvailableComparisons()
  • TagManager.getAvailableTagTypesInContext(idContext)
  • TagManager.getAvailableTriggerTypesInContext(idContext)
  • TagManager.getAvailableVariableTypesInContext(idContext)
  • TagManager.getContainerEmbedCode(idSite, idContainer, environment)
  • TagManager.getContainerInstallInstructions(idSite, idContainer, environment, jsFramework = '')
  • TagManager.getContainerTags(idSite, idContainer, idContainerVersion)
  • TagManager.createDefaultContainerForSite(idSite)
  • TagManager.addContainerTag(idSite, idContainer, idContainerVersion, type, name, parameters = 'Array', fireTriggerIds = 'Array', blockTriggerIds = 'Array', fireLimit = 'unlimited', fireDelay = '0', priority = '999', startDate = '', endDate = '', description = '')
  • TagManager.updateContainerTag(idSite, idContainer, idContainerVersion, idTag, name, parameters = 'Array', fireTriggerIds = 'Array', blockTriggerIds = 'Array', fireLimit = 'unlimited', fireDelay = '0', priority = '999', startDate = '', endDate = '', description = '')
  • TagManager.deleteContainerTag(idSite, idContainer, idContainerVersion, idTag)
  • TagManager.getContainerTag(idSite, idContainer, idContainerVersion, idTag)
  • TagManager.getContainerTriggerReferences(idSite, idContainer, idContainerVersion, idTrigger)
  • TagManager.getContainerTriggers(idSite, idContainer, idContainerVersion)
  • TagManager.addContainerTrigger(idSite, idContainer, idContainerVersion, type, name, parameters = 'Array', conditions = 'Array', description = '')
  • TagManager.updateContainerTrigger(idSite, idContainer, idContainerVersion, idTrigger, name, parameters = 'Array', conditions = 'Array', description = '')
  • TagManager.deleteContainerTrigger(idSite, idContainer, idContainerVersion, idTrigger)
  • TagManager.getContainerTrigger(idSite, idContainer, idContainerVersion, idTrigger)
  • TagManager.getContainerVariableReferences(idSite, idContainer, idContainerVersion, idVariable)
  • TagManager.getContainerVariables(idSite, idContainer, idContainerVersion)
  • TagManager.getAvailableContainerVariables(idSite, idContainer, idContainerVersion)
  • TagManager.addContainerVariable(idSite, idContainer, idContainerVersion, type, name, parameters = 'Array', defaultValue = '', lookupTable = 'Array', description = '')
  • TagManager.updateContainerVariable(idSite, idContainer, idContainerVersion, idVariable, name, parameters = 'Array', defaultValue = '', lookupTable = 'Array', description = '')
  • TagManager.deleteContainerVariable(idSite, idContainer, idContainerVersion, idVariable)
  • TagManager.getContainerVariable(idSite, idContainer, idContainerVersion, idVariable)
  • TagManager.getContainers(idSite)
  • TagManager.addContainer(idSite, context, name, description = '', ignoreGtmDataLayer = '0')
  • TagManager.updateContainer(idSite, idContainer, name, description = '', ignoreGtmDataLayer = '0')
  • TagManager.createContainerVersion(idSite, idContainer, name, description = '', idContainerVersion = '')
  • TagManager.updateContainerVersion(idSite, idContainer, idContainerVersion, name, description = '')
  • TagManager.getContainerVersions(idSite, idContainer)
  • TagManager.getContainerVersion(idSite, idContainer, idContainerVersion)
  • TagManager.deleteContainerVersion(idSite, idContainer, idContainerVersion)
  • TagManager.publishContainerVersion(idSite, idContainer, idContainerVersion, environment)
  • TagManager.deleteContainer(idSite, idContainer)
  • TagManager.getContainer(idSite, idContainer)
  • TagManager.enablePreviewMode(idSite, idContainer, idContainerVersion = '')
  • TagManager.disablePreviewMode(idSite, idContainer)
  • TagManager.changeDebugUrl(idSite, url)
  • TagManager.exportContainerVersion(idSite, idContainer, idContainerVersion = '')
  • TagManager.importContainerVersion(exportedContainerVersion, idSite, idContainer, backupName = '')
↑ haut de page

Tour3 méthodes

Progression dans la visite guidée et les défis proposés à la prise en main.

  • Tour.getChallenges()
  • Tour.skipChallenge(id)
  • Tour.getLevel()
↑ haut de page

Transitions5 méthodes

Transitions : ce qui précède et ce qui suit immédiatement une page donnée, pages internes, référents externes et sorties.

  • Transitions.getTransitionsForPageTitle(string pageTitle, idSite, period, date, segment = '', limitBeforeGrouping = '0')
  • Transitions.getTransitionsForPageUrl(string pageUrl, idSite, period, date, segment = '', limitBeforeGrouping = '0')
  • Transitions.getTransitionsForAction(string actionName, string actionType, idSite, period, date, segment = '', limitBeforeGrouping = '0', parts = 'all')
  • Transitions.getTranslations()
  • Transitions.isPeriodAllowed(idSite, period, date)
↑ haut de page

TwoFactorAuth1 méthode

Authentification à deux facteurs.

  • TwoFactorAuth.resetTwoFactorAuth(userLogin, passwordConfirmation)
↑ haut de page

UserCountry8 méthodes

Localisation des visiteurs : pays, continent, région et ville, avec la possibilité de réattribuer les visites déjà enregistrées.

  • UserCountry.getCountry(idSite, period, date, segment = '')
  • UserCountry.getContinent(idSite, period, date, segment = '')
  • UserCountry.getRegion(idSite, period, date, segment = '')
  • UserCountry.getCity(idSite, period, date, segment = '')
  • UserCountry.getCountryCodeMapping()
  • UserCountry.getLocationFromIP(ip = '', provider = '')
  • UserCountry.setLocationProvider(providerId)
  • UserCountry.getNumberOfDistinctCountries(idSite, period, date, segment = '')
↑ haut de page

UserId1 méthode

Rapport par identifiant utilisateur, quand un User ID est transmis au suivi.

  • UserId.getUsers(idSite, period, date, segment = '')
↑ haut de page

UserLanguage2 méthodes

Langue déclarée par le navigateur du visiteur, et code de langue seul.

  • UserLanguage.getLanguage(idSite, period, date, segment = '')
  • UserLanguage.getLanguageCode(idSite, period, date, segment = '')
↑ haut de page

UsersFlow4 méthodes

Parcours des visiteurs d'une page à l'autre, sous forme de flux sur plusieurs étapes.

  • UsersFlow.getUsersFlowPretty(idSite, period, date, segment = '', expanded = '', flat = '', idSubtable = '', dataSource = '')
  • UsersFlow.getUsersFlow(idSite, period, date, limitActionsPerStep = '5', exploreStep = '', exploreUrl = '', segment = '', expanded = '', dataSource = '')
  • UsersFlow.getInteractionActions(idSite, period, date, interactionPosition, offsetActionsPerStep = '', segment = '', idSubtable = '', dataSource = '')
  • UsersFlow.getAvailableDataSources()
↑ haut de page

UsersManager31 méthodes

Gestion des comptes : création, modification, suppression, droits par site, invitations, jetons d'authentification et préférences.

  • UsersManager.getAvailableRoles()
  • UsersManager.getAvailableCapabilities()
  • UsersManager.setUserPreference(userLogin, preferenceName, preferenceValue)
  • UsersManager.getUserPreference(preferenceName, userLogin = '')
  • UsersManager.getUsersPlusRole(idSite, limit = '', offset = '0', filter_search = '', filter_access = '', filter_status = '')
  • UsersManager.getUsers(userLogins = '')
  • UsersManager.getUsersLogin()
  • UsersManager.getUsersSitesFromAccess(access)
  • UsersManager.getUsersAccessFromSite(idSite)
  • UsersManager.getUsersWithSiteAccess(idSite, access)
  • UsersManager.getSitesAccessFromUser(userLogin)
  • UsersManager.getSitesAccessForUser(userLogin, limit = '', offset = '0', filter_search = '', filter_access = '')
  • UsersManager.getUser(userLogin)
  • UsersManager.getUserByEmail(userEmail)
  • UsersManager.addUser(userLogin, password, email, initialIdSite = '', passwordConfirmation = '')
  • UsersManager.inviteUser(userLogin, email, initialIdSite = '', expiryInDays = '', passwordConfirmation = '')
  • UsersManager.setSuperUserAccess(userLogin, hasSuperUserAccess, passwordConfirmation = '')
  • UsersManager.hasSuperUserAccess()
  • UsersManager.getUsersHavingSuperUserAccess()
  • UsersManager.updateUser(userLogin, password = '', email = '', passwordConfirmation = '')
  • UsersManager.deleteUser(userLogin, passwordConfirmation = '')
  • UsersManager.userExists(userLogin)
  • UsersManager.userEmailExists(userEmail)
  • UsersManager.getUserLoginFromUserEmail(userEmail)
  • UsersManager.setUserAccess(userLogin, access, idSites)
  • UsersManager.addCapabilities(userLogin, capabilities, idSites)
  • UsersManager.removeCapabilities(userLogin, capabilities, idSites)
  • UsersManager.createAppSpecificTokenAuth(userLogin, passwordConfirmation, description, expireDate = '', expireHours = '0')
  • UsersManager.newsletterSignup()
  • UsersManager.resendInvite(userLogin, expiryInDays = '7', passwordConfirmation = '')
  • UsersManager.generateInviteLink(userLogin, expiryInDays = '7', passwordConfirmation = '')
↑ haut de page

VisitFrequency1 méthode

Fidélité : comparaison entre nouvelles visites et visites de retour.

  • VisitFrequency.get(idSite, period, date, segment = '', columns = '')
↑ haut de page

VisitorInterest4 méthodes

Engagement : nombre de pages vues par visite, durée des visites, nombre de visites par visiteur et délai depuis la visite précédente.

  • VisitorInterest.getNumberOfVisitsPerVisitDuration(idSite, period, date, segment = '')
  • VisitorInterest.getNumberOfVisitsPerPage(idSite, period, date, segment = '')
  • VisitorInterest.getNumberOfVisitsByDaysSinceLast(idSite, period, date, segment = '')
  • VisitorInterest.getNumberOfVisitsByVisitCount(idSite, period, date, segment = '')
↑ haut de page

VisitsSummary10 méthodes

Les métriques de base de l'audience : visites, visiteurs uniques, utilisateurs, actions, rebonds, visites converties et temps passé.

  • VisitsSummary.get(idSite, period, date, segment = '', columns = '')
  • VisitsSummary.getVisits(idSite, period, date, segment = '')
  • VisitsSummary.getUniqueVisitors(idSite, period, date, segment = '')
  • VisitsSummary.getUsers(idSite, period, date, segment = '')
  • VisitsSummary.getActions(idSite, period, date, segment = '')
  • VisitsSummary.getMaxActions(idSite, period, date, segment = '')
  • VisitsSummary.getBounceCount(idSite, period, date, segment = '')
  • VisitsSummary.getVisitsConverted(idSite, period, date, segment = '')
  • VisitsSummary.getSumVisitsLength(idSite, period, date, segment = '')
  • VisitsSummary.getSumVisitsLengthPretty(idSite, period, date, segment = '')
↑ haut de page

VisitTime3 méthodes

Répartition des visites dans le temps : heure locale du visiteur, heure du serveur et jour de la semaine.

  • VisitTime.getVisitInformationPerLocalTime(idSite, period, date, segment = '')
  • VisitTime.getVisitInformationPerServerTime(idSite, period, date, segment = '', hideFutureHoursWhenToday = '')
  • VisitTime.getByDayOfWeek(idSite, period, date, segment = '')
↑ haut de page
À propos de cette page. Cette liste a été générée depuis une instance Matomo réelle, plugins premium compris — c'est pourquoi on y trouve des modules absents d'une installation standard (Heatmap & Session Recording, Form Analytics, Media Analytics, Crash Analytics, Custom Reports, Funnels, Roll-Up Reporting…). Les méthodes disponibles sur votre instance dépendent des plugins que vous avez activés : la méthode API.getReportMetadata vous donnera la liste exacte pour votre installation. Matomo évoluant à chaque version, référez-vous à la documentation officielle pour l'état courant. Cette page remplace le PDF qui circulait auparavant à l'adresse full-matomo-api.pdf : cette ancienne adresse redirige désormais ici.
Confidentialité des Données Mentions Légales CGV