报告API参考
这是Matomo API参考。它列出了所有可以调用的函数，记录了参数，并以各种格式链接到每个调用的示例。
api允许您以编程方式从Matomo请求任何分析报告，适用于一个或多个网站，适用于任何给定的日期和时期以及任何格式(CSV, JSON, XML等)。Matomo还提供管理api来创建、更新和删除网站、用户、用户权限、自定义仪表板、电子邮件报告、目标、漏斗、自定义维度、警报、视频、热图、会话记录、自定义片段等。
API请求
标准API参数
idSite
- 你的网站的整数id，例如。idSite = 1
- 您还可以指定一个idSites列表，以逗号分隔，例如。idSite = 1, 4、5、6所示
- 如果您想获取所有网站的数据，请设置idSite =所有(这只被一些API方法支持，可能会有问题，例如维度，目标，或段只对特定的网站可用)
期-请求统计的时间段。可以是以下任何一种:一天，周，月，一年或范围．所有报告将根据网站的时区返回日期。
- 一天返回给定日期的数据。
- 周返回包含指定“日期”的周数据
- 月返回包含指定“日期”的月份的数据
- 一年返回包含指定“日期”的年份数据
- 范围返回指定'date'范围的数据。
例如，要申请一份1月1日至2月15日的报告，你可以这样写时间= range&date = 2011-01-01, 2011-02-15
日期
- 标准格式=YYYY-MM-DD
- 神奇的关键词=今天，昨天，上一周，上个月或去年．这些都是相对的网站时区。例如，对于UTC+12时区的网站，对于UTC时间2010-01-01下午5点的API请求，“date=today”将返回2010-01-02的报告。(注意:上一周，上个月而且去年仅在Matomo 4.1可用)
日期范围
- lastX对于包括今天在内的最后X个时间段(例如&date=last10&period=day将返回包括今天在内的过去10天中的每一天的条目)。这是相对于网站时区。
- previousX返回今天之前的最后X个周期(例如;&date=previous52&period=week将返回本周之前52周的每个条目)。这是相对于网站时区。
YYYY-MM-DD, YYYY-MM-DD对于日期范围内的每个时期(日、周、月或年)
注意:如果你设置'period=range'来请求自定义日期范围的数据，API将返回指定日期范围的数据总和。当'period=range'时，参数'date'支持以下关键字:
lastX
- previousX
- YYYY-MM-DD, YYYY-MM-DD，两个日期都可以用神奇的关键字替换(第一个不支持今天而且昨天)．如。YYYY-MM-DD,今天，上个月,YYYY-MM-DD或去年,上一周
段-定义要过滤报表的自定义段。
格式；定义输出的格式
- xml
- Json(如果你想做ajax中的跨域请求和获取json数据时，可以将json数据封装在函数调用周围jsoncallback参数)
- CSV(逗号分隔值)
- tsv(以制表符分隔的值，类似于CSV，但在Excel中可以正常加载)
- 超文本标记语言
- rss(当日期是一个范围，例如date=last10或date= preous15)
- 原始的;获取原始的PHP数据结构。这在调用Matomo(以前是Piwik) API时非常有用内部使用PHP代码
filter_limit；定义要返回的行数。
- 默认情况下，只有顶部100行返回。
- 设置为-1返回所有行。
可选API参数
每个API调用都可以包含一些参数，这些参数不会出现在参数列表中，而是充当“过滤器”。过滤器可以是表示过滤器(例如;指定国际化语言)，或者充当数据助手(排序结果、搜索数据集子集、获取给定实体的子实体)。一些参数比如filter_sort_order而且filter_sort_column只适用于返回报告的API方法，而不适用于返回实体(如站点、用户、活动)的API方法。
以下是可以添加到任何API请求的参数的概述:
语言；如果指定，则返回可国际化并将被翻译的数据字符串。例如，Live API返回的日期和时间可以被翻译成指定的语言。期望值是2个语言字母代码，例如。En, fr, de, es等。您可以通过调用LanguagesManager API来获得可用的语言列表。
idSubtable用于请求给定行的子表。在Matomo中，一些行被链接到子表。例如，Referrers中的每一行。getSearchEngines响应有一个“idsubdatatable”字段。这个整数idsubdatatable是包含此搜索引擎的所有关键字的表的idSubtable。然后，您可以通过调用referrer请求此搜索引擎的关键字。getKeywordsFromSearchEngineId与参数idSubtable=X(替换X与idsubdatatable值在Referrers中找到。getSearchEngines响应，用于您感兴趣的搜索引擎)。
扩大；一些API函数有一个参数“expanded”。如果'expanded'设置为1，则返回的数据将包含第一级结果以及所有子表。例如，看为Actions返回数据集。getDownloads API函数．
平；一些API函数有一个参数“expanded”，这意味着数据是分层的。对于这样的API函数，如果'flat'设置为1，返回的数据将包含表数据集的扁平视图。所有第一级行的子行将聚合在一行下。这很有用，例如，一次查看所有自定义变量的名称和值，例如，Matomo论坛用户状态，或查看不按目录或结构划分的完整网址。
标签；此参数可用于仅搜索与给定标签匹配的行。指定后，将过滤报表数据并只返回行标签与指定参数匹配的行。例如，您可以设置&label=Nice%20Keyword以只保留带有“Nice Keyword”标签的行。也有通用过滤器，你可以选择应用于所有返回web分析报告的api。例如，有一个过滤器用于按列排序，定义要返回的行数和起始行数，一个过滤器仅返回与给定字符串匹配的行，
pivotBy；此参数可用于创建使用指定维度的报表的数据透视表。旋转报表将使报表与另一个报表交叉，并沿两个维度显示单个度量值。若要枢轴分析报表，此查询参数必须设置为要枢轴分析的维度的ID。例如,queryParam =反向链接。关键字将围绕关键字维度旋转。
注意:如果要以不是报表子表的维度为枢轴，则必须将pivot_by_filter_enable_fetch_by_segmentINI配置变量为1。使用分段将允许您以任何维度作为枢轴，但目前，它会很慢。
- pivotByColumn；指定应在枢轴报告中显示的列。应该和pivotBy并设置为列名，例如，nb_visits．
pivotByColumnLimit；透视表中应显示的最大列数。所有其他列都聚合到“其他”列中。
filter_offset；定义返回的起始行偏移量
- filter_truncate；如果设置，将在$filter_truncate rows之后截断表。最后一行将被命名为“Others”(以所请求的语言进行本地化)，列将是所有截断行的统计数据的汇总。
- filter_pattern；控件中要搜索的文本filter_column．只返回与给定列匹配的行。模式将被解释为正则表达式。例子:
(en | de) \ .mydomain．
- filter_column；定义要搜索文本的列(请参阅filter_pattern)．如果未指定，默认为'label'
- filter_sort_order；定义结果的顺序，asc或desc
- filter_sort_column；定义要排序的列
- filter_excludelowpop；定义用于value阈值的列filter_excludelowpop_value；只有值大于的列filter_excludelowpop_value；将被退回
- filter_excludelowpop_value；属性的最小值filter_excludelowpop列
- hideColumns；用逗号分隔的列列表。如果设置，则从结果中删除这些列。这可以用来减少传输的数据量。
- showColumns；用逗号分隔的列列表。设置后，删除结果中未在此列表中找到的所有列。这可以用来减少传输的数据量。
convertToUnicode；仅当格式是CSV或tsv。默认情况下(当设置为1时)，输出以UTF-16LE编码发送。如果设置为0，则输出将以UTF-8编码发送。
filter_column_recursive；定义递归搜索模式时要搜索的列filter_pattern_recursive
filter_pattern_recursive；定义您正在搜索的文本。只返回匹配的行。此过滤器应用于递归表(Actions/Downloads/Outlinks表)
disable_generic_filters；如果设置为1，上面所有的通用过滤器都不会被应用。这对于禁用上面使用默认值应用的过滤器非常有用。主要用于内部或开发Matomo插件时。
disable_queued_filters；如果设置为1，所有主要是表示过滤器(替换列名，在列上应用回调以添加新信息，如浏览器图标URL等)将不会被应用。主要用于内部或开发Matomo插件时。
translateColumnNames；属性所指定的语言语言参数说明。注意:此参数仅对CSV、RSS和HTML输出格式有效。
将数据数组作为参数传递
一些参数可以选择接受数组。例如，SitesManager的url参数。addSite SitesManager。addSiteAliasUrls和SitesManager。updateSite允许传递一个url数组。要传递一个数组，在get请求中为参数名添加括号操作符和索引。调用SitesManager。有两个url的addSite你会使用下面的数组:
https://demo.m.hju8.com/?module=API&method=SitesManager.addSite&siteName=new%20example%20website&urls [0] = https://example.org&urls [1] = https://example-alias.org
高级用户:一次发送多个API请求
有时需要多次调用Matomo API来获取报告或自定义应用程序所需的数据。当您需要同时调用许多API函数，或者如果您只是不想发出大量HTTP请求时，您可能会考虑使用大量API请求．该特性允许您通过一个HTTP请求(GET或POST)调用多个API方法。
要发出批量请求，请调用API。getBulkRequest方法，并传递API方法和参数(每个请求必须是URL编码)你希望调用'urls'查询参数。例如，调用VisitsSummary。get & VisitorInterest。同时获取numberofvisitspervisitduration，你可以使用:
https://demo.m.hju8.com/?module=API&method=API.getBulkRequest&format=json&urls[0] =方法% 3 dvisitssummary.get % 26 idsite % 3 d3 % 26日% 3 d2012-03-06 % 26期% 3 dday&urls[1] =方法% 3 dvisitorinterest.getnumberofvisitspervisitduration % 26 idsite % 3 d3 % 26日% 3 d2012-03-06 % % 3 dday 26期
注意urls[0]是对VisitsSummary的url编码调用。url[1]是你用来调用VisitorInterest的。getNumberOfVisitsPerVisitDuration。&format只指定一次(批量请求支持format=xml和format=json)。
API Response将是一个数组，其中包含每个API方法的格式化结果，在本例中是VisitsSummary。和VisitorInterest.getNumberOfVisitsPerVisitDuration。
你也可以发出Bulk请求作为HTTP POST请求来解决任何请求URI大小限制:
curl -i -X POST -d 'module=API&method=API.getBulkRequest&format=json&urls[0]=method%3dVisitsSummary.get%26idSite%3d3%26date%3d2012-03-06%26period%3dday&urls[1]=method%3dVisitorInterest。getNumberOfVisitsPerVisitDuration % 26 idsite % 3 d3 % 26日% 3 d2012-03-06 % 26期% 3 dday https://demo.m.hju8.com/index.php
通过token_auth参数对API进行身份验证
在上面的例子中，请求可以工作，因为统计信息是公共的匿名用户有一个视图访问网站)。默认情况下，在Matomo中你的统计数据是私有的。在你不能公开统计数据的情况下:
- 当你访问你的Matomo安装时，你会被要求登录
- 当你通过http调用API时，你需要验证你自己。这是通过添加一个名为
token_auth在URL中。此参数与您的登录名和密码一样保密!
下的Administration区域可以创建身份验证令牌政府= >个人= >安全= >身份验证令牌．
然后只需添加参数&token_auth = YOUR_TOKEN在API调用URL的末尾。
您不应该共享包含token_auth因为这个人可以使用相同的令牌在Matomo中获取和更改数据。
会话令牌
当您登录到Matomo并选择导出数据时，您可能会注意到一个参数&force_api_session = 1参数。当这个URL参数存在时，Matomo使用一个特殊的token_auth每次你登录时都会随机生成，这个URL只在你登录时有效，一旦你注销就不再有效。下次登录时，令牌将再次更改。如果希望URL永久工作，则需要删除此URL参数&force_api_session并将令牌替换为生成的认证令牌的值，参见上面。
API回应:度量定义
下面是API返回的指标及其定义的列表。
一般指标
nb_uniq_visitors—独立访问数nb_visits-访视次数(30分钟不活动视为一次新访视)nb_users-唯一活跃用户数量(已知用户ID)．如果你没有使用User ID，那么这个指标将被设置为零。nb_actions-操作数量(页面浏览量，外链和下载)sum_visit_length-总花费时间，以秒为单位bounce_count-弹出的访问次数(只浏览了一个页面)max_actions-一次访问的最大动作数nb_visits_converted-进球次数nb_conversions-进球转换次数收入-目标转换的总收益
特定于页面url和页面标题报告的指标
nb_hits-此页的浏览次数entry_nb_visits-从该页开始的访问次数entry_nb_uniq_visitors-在此页面开始访问的唯一访问者数量entry_nb_actions-从该页开始访问的页面浏览量entry_sum_visit_length-从该页开始的访问所花费的时间，以秒为单位entry_bounce_count-从此页开始并反弹的访问次数(只浏览了一页)exit_nb_visits-在此页完成的访问次数exit_nb_uniq_visitors-在此页结束访问的唯一访问者数量sum_time_spent-在此页面上花费的总时间，以秒为单位sum_daily_nb_uniq_visitors-期间内每日独立访客数之和。Matomo不会在整个时间段内处理独立访客。sum_daily_entry_nb_uniq_visitors-在本页开始访问的每日独立访问者总数sum_daily_exit_nb_uniq_visitors-(已弃用)同sum_daily_entry_nb_uniq_visitorsexit_bounce_count-(已弃用)同entry_bounce_count
avg_time_on_page-在此页面上花费的平均时间，以秒为单位bounce_rate-登陆此页后离开网站的访问比例exit_rate-在此页面之后不再浏览其他页面的访问量比例
电子商务指标，出现在电子商务目标。只调用getItems* API
收入-产品销售产生的总收入。不包括税、运费和折扣。数量-数量是指每个产品SKU/名称/类别所销售的产品总数。订单-至少一次包含此产品SKU/名称/类别的电子商务订单总数。abandoned_carts-此值仅在请求包含'& abandonedcart =1'时设置。在这种情况下，“订单”指标将不会返回。它是至少一次包含此产品SKU/名称/类别的废弃购物车的总数。avg_price-该产品/类别的平均收益。avg_quantity-该产品/类别的平均数量。nb_visits—此值仅在已设置时显示“电子商务产品/类别页面跟踪”．产品/类别页面的访问次数。conversion_rate—此值仅在已设置时显示“电子商务产品/类别页面跟踪”．转化率是包含该产品/类别的订单数(如果请求包含'& abandonedcart =1'则为abandoned_cart)除以该产品/类别页面的访问数。
事件跟踪指标，出现在事件API调用中
nb_events-事件数量nb_events_with_value—设置值的事件个数sum_event_value—“事件”值的和min_event_value-最小事件值max_event_value—最大事件值avg_event_value—事件值的平均值
术语表
Matomo Analytics中所有常用的术语都记录在亚博ap下载术语表包括所有的指标和报告。
API方法列表
快速访问api
API
AbTesting
行动
ActivityLog
AdvertisingConversionExport
注释
内容
CoreAdminHome
CustomAlerts
CustomDimensions
CustomJsTracker
CustomReports
CustomVariables
指示板
DevicePlugins
DevicesDetection
事件
反馈
FormAnalytics
漏斗
目标
HeatmapSessionRecording
ImageGraph
的见解
LanguagesManager
生活
登录
MarketingCampaignsReporting
MediaAnalytics
MobileMessaging
MultiChannelConversionAttribution
多点
覆盖
PagePerformance
PrivacyManager
反向链接
决议
RollUpReporting
搜索引擎优化
ScheduledReports
SearchEngineKeywordsPerformance
SegmentEditor
SitesManager
TagManager
之旅
转换
TwoFactorAuth
UserCountry
用户标识
UserLanguage
UsersFlow
UsersManager
VisitFrequency
VisitTime
VisitorInterest
VisitsSummary
模块API
这个API是
元数据API:它提供了所有其他可用API方法的信息，并提供了人类可读的和比普通API方法更完整的输出。元数据API返回的一些信息:
- 通过“getReportMetadata”动态生成的所有API方法列表
- 通过“getDefaultMetrics”和“getDefaultProcessedMetrics”，每个方法将返回的指标列表，以及它们的人类可读的名称
- 包含'segment'参数的所有函数所支持的段元数据列表
- (真正神奇的)方法“getprocessereport”将返回任何其他报告的人类可读版本，并包括处理过的指标，如转化率，现场时间等，这些在其他方法中无法直接获得。
- 方法"getSuggestedValuesForSegment"返回一个特定段的最高建议值。它使用Live。getLastVisitsDetails API获取最近使用的值，并将首先返回最常用的值。
例如，Matomo移动应用程序使用元数据API自动显示所有Matomo报告，带有翻译后的报告和列名以及格式化良好的值。更多有关
元数据API文档页面
-
API.getMetadata(idSite, apiModule, apiAction, apiParameters = 'Array'， language = "， period = "， date = "， hideMetricsDoc = "， showSubtableReports = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
API.getReportMetadata(idSites = "， period = "， date = "， hideMetricsDoc = "， showSubtableReports = "， idSite = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
API.getProcessedReport(idSite, period, date, apiModule, apiAction, segment = "， apiParameters = "， idGoal = "， language = "， showTimer = '1'， hideMetricsDoc = "， idSubtable = "， showRawMetrics = "， format_metrics = "， idDimension = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
API.getRowEvolution(idSite, period, date, apiModule, apiAction, label = "， segment = "， column = "， language = "， idGoal = "， legendAppendMetric = '1'， labelUseAbsoluteUrl = '1'， idDimension = "， labelSeries = "， showGoalMetricsForGoal = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-API.getBulkRequest(网址)[没有可用的例子]
-API.isPluginActivated(pluginName)[没有可用的例子]
模块AbTesting
-AbTesting.getMetricsOverview(idSite，时间段，日期，ideexperiment, segment = ")[没有可用的例子]
-AbTesting.getMetricDetails(idSite, period, date, ideexperiment, successMetric, segment = ")[没有可用的例子]
-AbTesting.addExperiment(idSite，名称，假设，描述，变体，包括目标，successMetrics)[没有可用的例子]
-AbTesting.updateExperiment(ideexperiment, idSite, name, description, hypothesis, variation, confidenceThreshold, mderrelative, percentageParticipants, successMetrics, incldedtargets, excludedTargets = 'Array'， startDate = "， endDate = ")[没有可用的例子]
-AbTesting.startExperiment(idExperiment idSite)[没有可用的例子]
-AbTesting.finishExperiment(idExperiment idSite)[没有可用的例子]
-AbTesting.archiveExperiment(idExperiment idSite)[没有可用的例子]
-AbTesting.getJsExperimentTemplate(idExperiment idSite)[没有可用的例子]
-AbTesting.getExperimentsByStatuses(idSite状态)[没有可用的例子]
-AbTesting.getExperiment(idExperiment idSite)[没有可用的例子]
-AbTesting.deleteExperiment(idExperiment idSite)[没有可用的例子]
模块操作
action API允许您请求所有访问者操作的报告:页面url、页面标题、事件、内容跟踪、文件下载和外部网站上的点击。例如，"getPageTitles"将返回所有的页面标题和标准
行为指标对于每一行。也可以使用"getPageTitle"来请求特定页面标题的数据，并将参数pageName设置为您希望请求的页面标题。类似地，您可以通过"getPageUrl"请求给定页面URL的指标，通过"getDownload"请求下载文件，通过"getOutlink"请求输出链接。注意:pageName, pageUrl, outlinkUrl, downloadUrl参数必须在调用API之前进行URL编码。
-
Actions.getPageUrls(idSite，时间段，日期，segment = "， expanded = "， idSubtable = "， depth = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Actions.getPageUrlsFollowingSiteSearch(idSite，时间段，日期，segment = "， expanded = "， idSubtable = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Actions.getPageTitlesFollowingSiteSearch(idSite，时间段，日期，segment = "， expanded = "， idSubtable = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Actions.getEntryPageUrls(idSite，时间段，日期，segment = "， expanded = "， idSubtable = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Actions.getExitPageUrls(idSite，时间段，日期，segment = "， expanded = "， idSubtable = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Actions.getPageTitles(idSite，时间段，日期，segment = "， expanded = "， idSubtable = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Actions.getEntryPageTitles(idSite，时间段，日期，segment = "， expanded = "， idSubtable = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Actions.getExitPageTitles(idSite，时间段，日期，segment = "， expanded = "， idSubtable = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Actions.getPageTitle(pageName, idSite, period, date, segment = " ")[没有可用的例子]
-
Actions.getDownloads(idSite，时间段，日期，segment = "， expanded = "， idSubtable = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Actions.getDownload(downloadUrl, idSite, period, date, segment = ")[没有可用的例子]
-
Actions.getOutlinks(idSite，时间段，日期，segment = "， expanded = "， idSubtable = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Actions.getOutlink(outlinkUrl, idSite, period, date, segment = ")[没有可用的例子]
-
Actions.getSiteSearchNoResultKeywords(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块ActivityLog
活动日志API用于获取Matomo实例中用户的活动日志。
该方法
ActivityLog.getEntries返回用户在Matomo实例中所做的活动的列表。
返回的activity列表取决于哪个用户正在调用API:
-如果您使用超级用户访问身份验证，API将返回所有用户的活动日志
-如果您的身份验证为匿名(无身份验证)，或具有视图或管理员访问权限的用户，则只返回该用户的活动。
每个活动包括一个活动ID、发起该活动的用户、特定于该活动的参数/元数据列表、日期时间(以及漂亮的日期时间)、活动描述和该用户的彩色头像图像的URL。
活动日志包括超过80种不同类型的Matomo活动，例如:
—查看用户何时登录、登录失败或退出
-查看用户是由谁创建、更新或删除的
-查看网站是由谁创建、更新或删除的
-当Matomo设置，一个
A / B测试,一个
计划报告，或
段被谁改变了
-
ActivityLog.getEntries(offset = '0'， limit = '25'， filterByUserLogin = "， filterByActivityType = ")
[示例]XML，Json，Tsv (Excel)］
-
ActivityLog.getEntryCount(filterByUserLogin = "， filterByActivityType = ")
[示例]XML，Json，Tsv (Excel)］
模块AdvertisingConversionExport
-AdvertisingConversionExport.getConversionExport(idExport)[没有可用的例子]
-AdvertisingConversionExport.deleteConversionExport(idExport idSite)[没有可用的例子]
-AdvertisingConversionExport.addConversionExport(idSite，名称，类型，参数，description = ")[没有可用的例子]
-AdvertisingConversionExport.regenerateAccessToken(idExport)[没有可用的例子]
-AdvertisingConversionExport.updateConversionExport(idExport, idSite，名称，类型，参数，description = ")[没有可用的例子]
模块注释
注释插件的API。提供创建、修改、删除和查询注释的方法。
-Annotations.add(idSite, date, note， * = '0')[没有可用的例子]
-Annotations.save(idSite, idNote, date = "， note = "， * * = ")[没有可用的例子]
-Annotations.delete(idSite idNote)[没有可用的例子]
-Annotations.get(idSite idNote)[没有可用的例子]
-
Annotations.getAnnotationCountForDates(idSite, date, period, lastN = "， getAnnotationText = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块内容
插件API
-
Contents.getContentPieces(idSite，时间段，日期，segment = "， idSubtable = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块CoreAdminHome
-CoreAdminHome.deleteTrackingFailure(idSite idFailure)[没有可用的例子]
模块CustomAlerts
-CustomAlerts.getValuesForAlertInPast(idAlert subPeriodN)[没有可用的例子]
-CustomAlerts.addAlert(name, idSites, period, emailMe, additionalemail, phoneNumbers, metric, metricCondition, metricValue, compardto, reportUniqueId, reportCondition = "， reportValue = ")[没有可用的例子]
-CustomAlerts.editAlert(idAlert, name, idSites, period, emailMe, additionalemail, phoneNumbers, metric, metricCondition, metricValue, compardto, reportUniqueId, reportCondition = "， reportValue = ")[没有可用的例子]
模块CustomDimensions
自定义维度API允许您管理和访问已配置的自定义维度的报告。
-CustomDimensions.getCustomDimension(idDimension, idSite, period, date, segment = "， expanded = "， flat = "， idSubtable = ")[没有可用的例子]
-CustomDimensions.configureNewCustomDimension(idSite, name, scope, active, extracts = 'Array'， caseSensitive = '1')[没有可用的例子]
-CustomDimensions.configureExistingCustomDimension(idDimension, idSite, name, active, extractions = 'Array'， caseSensitive = ")[没有可用的例子]
-CustomDimensions.getConfiguredCustomDimensionsHavingScope(idSite范围)[没有可用的例子]
模块CustomJsTracker
插件CustomJsTracker的API
模块CustomReports
的
自定义报告API允许您1)在Matomo中创建自定义报告2)在Matomo Reporting UI中查看创建的报告或通过API使用它们。
您可以在不同的可视化(如表格或演化图)之间进行选择，并结合数百个维度和指标来获得所需的数据。
-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 = ")
[示例]XML，Json，Tsv (Excel)］
-CustomReports.getConfiguredReport(idSite idCustomReport)[没有可用的例子]
-CustomReports.deleteCustomReport(idSite idCustomReport)[没有可用的例子]
-CustomReports.getCustomReport(idSite，时间段，日期，idCustomReport, segment = "， expanded = "， flat = "， idSubtable = "， columns = ")[没有可用的例子]
模块CustomVariables
自定义变量API允许您访问您的报表
自定义变量名称和值。
-
CustomVariables.getCustomVariables(idSite，时间段，日期，segment = "， expanded = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-CustomVariables.getCustomVariablesValuesFromNameId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
仪表板模块
-Dashboard.createNewDashboardForUser(login, dashboardName = "， addDefaultWidgets = '1')[没有可用的例子]
-Dashboard.removeDashboard(idDashboard, login = ")[没有可用的例子]
-Dashboard.copyDashboardToUser(idDashboard, copyToUser, dashboardName = ")[没有可用的例子]
-Dashboard.resetDashboardLayout(idDashboard, login = ")[没有可用的例子]
模块DevicePlugins
DevicePlugins API允许您访问有关设备插件(如浏览器插件)的报告。
模块DevicesDetection
DevicesDetection API可以让您访问您的访客设备，品牌，型号，操作系统，浏览器的报告。
-
DevicesDetection.getBrowserVersions(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
DevicesDetection.getBrowserEngines(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块事件
事件API允许您请求关于用户自定义事件的报告。事件跟踪使用Javascript跟踪trackEvent()函数，或使用[跟踪HTTP API](http://developer.m.hju8.com/api-reference/tracking-api)。
一个事件由一个事件类别(视频、音乐、游戏……)、一个事件动作(播放、暂停、持续时间、添加播放列表、下载、单击……)、一个可选的事件名称(电影名称、歌曲标题等)和一个可选的数值定义。
这个API公开了以下自定义事件报告:
getCategory列出了最热门的事件类别，
getAction列出顶部的事件动作，
getName列出顶级事件名称。
这些事件报告定义了以下指标:nb_uniq_visitors, nb_visitors, nb_events。如果为事件定义值，则可以预期看到以下指标:nb_events_with_value、sum_event_value、min_event_value、max_event_value、avg_event_value
的事件。Get *报告可以与可选的
&secondaryDimension参数。次要维度是您请求的事件报告子表中使用的维度。
这里是的可能值
secondaryDimension：
- 为
Events.getCategory你可以设置secondaryDimension来eventAction或eventName．
- 为
Events.getAction你可以设置secondaryDimension来eventName或eventCategory．
- 为
Events.getName你可以设置secondaryDimension来eventAction或eventCategory．
例如，要请求所有自定义事件类别，对于每个，顶级事件操作，您将请求:
方法= Events.getCategory&secondaryDimension = eventAction&flat = 1．你也可以省略
平= 1在这种情况下，要获得一个事件类别的顶级事件操作，请使用
方法= Events.getActionFromCategoryId传递给
&idSubtable =此事件类别。
-
Events.getCategory(idSite，时间段，日期，segment = "， expanded = "， secondaryDimension = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Events.getAction(idSite，时间段，日期，segment = "， expanded = "， secondaryDimension = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Events.getName(idSite，时间段，日期，segment = "， expanded = "， secondaryDimension = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Events.getActionFromCategoryId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-Events.getNameFromCategoryId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-Events.getCategoryFromActionId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-Events.getNameFromActionId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-Events.getActionFromNameId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-Events.getCategoryFromNameId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
模块的反馈
插件反馈API
-Feedback.sendFeedbackForFeature(featureName, like = "， choice = "， message = ")[没有可用的例子]
-Feedback.sendFeedbackForSurvey(question, message = ")[没有可用的例子]
模块FormAnalytics
的
形式分析API可以让你1)在Matomo中管理表单2)请求所有的表单分析报告和指标。
1)您可以创建，更新，删除表单，以及请求任何表单
存档他们。
2)请求所有关于用户如何与你的表单交互的指标和报告:
-按页面URL使用表单，查看相同的表单是否在不同页面上使用不同。
-输入字段，看看他们从哪里开始填写您的表格。
-删除字段以查看用户将表单留在何处。
-现场计时报告，以了解您的用户在哪里花费的时间最多。
-字段大小报告，以查看您的用户输入多少文本。
-大多数更正字段报告，以了解更多用户在填写表单时遇到的问题。
-报告不需要的字段，查看哪些字段经常留空。
-所有指标的几个演变报告，看看你的形式如何随着时间的推移表现。
以及以下指标:
表单域与(例如)交互的频率是多少?专注或改变)。
-当访问者开始填写表单时，他们首先与哪些字段进行交互。
-哪些字段导致访问者停止填写表单(下拉列表)。
-访问者更改表单字段或进行修改的频率。
-字段被重新聚焦或更正的频率(例如退格键或删除键，光标键的使用，…)
-他们在你的每个文本框中输入多少文本。
-哪些字段是不需要的，经常留空。
访问者在开始改变一个领域之前犹豫(等待)了多长时间。
-你的访问者在每个领域花费了多少时间。
-FormAnalytics.addForm(idSite, name, description = "， matchFormRules = "， matchpagerrules = "， conversionRules = ")[没有可用的例子]
-FormAnalytics.updateForm(idSite, idForm, name, description = "， matchFormRules = "， matchPageRules = "， conversionRules = ")[没有可用的例子]
-FormAnalytics.getForm(idSite idForm)[没有可用的例子]
-FormAnalytics.getFormsByStatuses(idSite状态)[没有可用的例子]
-FormAnalytics.deleteForm(idSite idForm)[没有可用的例子]
-FormAnalytics.archiveForm(idSite idForm)[没有可用的例子]
-
FormAnalytics.get(idSite，时间段，日期，idForm = "， segment = "， columns = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-FormAnalytics.getEntryFields(idSite，时间段，日期，idForm, segment = ")[没有可用的例子]
-FormAnalytics.getDropOffFields(idSite，时间段，日期，idForm, segment = ")[没有可用的例子]
-FormAnalytics.getPageUrls(idSite，时间段，日期，idForm, segment = ")[没有可用的例子]
-FormAnalytics.getFieldTimings(idSite，时间段，日期，idForm, segment = ")[没有可用的例子]
-FormAnalytics.getFieldSize(idSite，时间段，日期，idForm, segment = ")[没有可用的例子]
-FormAnalytics.getUneededFields(idSite，时间段，日期，idForm, segment = ")[没有可用的例子]
-FormAnalytics.getMostUsedFields(idSite，时间段，日期，idForm, segment = ")[没有可用的例子]
-FormAnalytics.getFieldCorrections(idSite，时间段，日期，idForm, segment = ")[没有可用的例子]
-FormAnalytics.updateFormFieldDisplayName(idSite, idForm, fields = 'Array')[没有可用的例子]
-
FormAnalytics.getCurrentMostPopularForms(idSite, lastMinutes, filter_limit = '5'， segment = ")
[示例]XML，Json，Tsv (Excel)］
模块漏斗
插件漏斗的API
-
Funnels.getMetrics(idSite，时间段，日期，idFunnel = "， idGoal = "， segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Funnels.getFunnelFlow(idSite，时间段，日期，idFunnel = "， idGoal = "， segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Funnels.getFunnelEntries(idSite，时间段，日期，idFunnel, segment = "， step = "， expanded = "， idSubtable = "， flat = ")[没有可用的例子]
-Funnels.getFunnelExits(idSite，时间段，日期，idFunnel, segment = "， step = ")[没有可用的例子]
-Funnels.getGoalFunnel(idSite idGoal)[没有可用的例子]
-Funnels.deleteGoalFunnel(idSite idGoal)[没有可用的例子]
-Funnels.setGoalFunnel(idSite, idGoal, isActivated, steps)[没有可用的例子]
-Funnels.testUrlMatchesSteps(url、步骤)[没有可用的例子]
模块的目标
目标API可以让你管理现有的目标，通过“updateGoal”和“deleteGoal”，通过“addGoal”创建新的目标，或者通过“getGoals”列出一个或几个网站的现有目标
跟踪电子商务订单和产品在你的网站上，函数“getItemsSku”，“getItemsName”和“getItemsCategory”将返回在你的网站上购买的产品列表，要么按产品SKU，产品名称或产品类别分组。对于每个名称、SKU或类别，将返回以下指标:总收入、总数量、平均价格、平均数量、包含该产品的订单数量(或废弃购物车)、产品页面的访问次数、转化率。默认情况下，这些函数返回“已购买的产品”。这些函数也接受一个可选参数& abandonedcart =1。如果设置了该参数，它将返回遗留在废弃购物车中因此没有购买的产品的指标。API还允许您通过“get”方法请求总体目标指标:转换率，至少有一次转换率的访问量，转化率和收入。如果您希望请求关于电子商务目标的特定指标，您可以设置参数&idGoal=ecommerceAbandonedCart来获得关于废弃购物车的指标(包括损失的收入，以及购物车中剩下的物品数量)或&idGoal=ecommerceOrder来获得关于电子商务订单的指标(订单数量，订单访问次数，小计，税收，运输，折扣，收入，订购的物品)
跟踪目标在Matomo。
-Goals.getGoal(idSite idGoal)[没有可用的例子]
-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, abandonedcart = "， segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Goals.getItemsName(idSite, period, date, abandonedcart = "， segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Goals.getItemsCategory(idSite, period, date, abandonedcart = "， segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Goals.get(idSite，时间段，日期，segment = "， idGoal = "， columns = 'Array'， showAllGoalSpecificMetrics = "， compare = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Goals.getDaysToConversion(idSite, period, date, segment = "， idGoal = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Goals.getVisitsUntilConversion(idSite, period, date, segment = "， idGoal = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块HeatmapSessionRecording
插件热图和会话记录的API。当您为热图或记录会话请求活动数据时，请注意，任何X或Y坐标、滚动到达位置和折叠上方都是相对的，而不是绝对的。X和Y坐标在0到2000之间，相对于选择器，其中2000表示位置在元素的100%，1000表示位置在元素的50%，0表示位置实际距离元素为0像素。滚动和以上的折叠位置在0到1000之间。例如，如果一个网页是3000像素高，滚动范围是100，这意味着用户已经看到了300像素的内容(10%，或1000中的100)。这里我们区分了两个不同的ID: idSiteHsr表示热图或会话记录配置的ID idLogHsr表示实际记录/跟踪的会话或热图活动的ID
-HeatmapSessionRecording.addHeatmap(idSite, name, matchPageRules, sampleLimit = '1000'， sampleRate = '5'， excludedElements = "， screenshotUrl = "， breakpointMobile = "， breakpointTablet = ")[没有可用的例子]
-HeatmapSessionRecording.updateHeatmap(idSite, idSiteHsr, name, matchPageRules, sampleLimit = '1000'， sampleRate = '5'， excludedElements = "， screenshotUrl = "， breakpointMobile = "， breakpointTablet = ")[没有可用的例子]
-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.deleteHeatmap(idSite idSiteHsr)[没有可用的例子]
-HeatmapSessionRecording.endHeatmap(idSite idSiteHsr)[没有可用的例子]
-HeatmapSessionRecording.deleteSessionRecording(idSite idSiteHsr)[没有可用的例子]
-HeatmapSessionRecording.endSessionRecording(idSite idSiteHsr)[没有可用的例子]
-
HeatmapSessionRecording.getHeatmaps(idSite, includePageTreeMirror = '1')
[示例]XML，Json，Tsv (Excel)］
-HeatmapSessionRecording.getRecordedSessions(idSite，时间段，日期，idSiteHsr, segment = "， idSubtable = ")[没有可用的例子]
-HeatmapSessionRecording.getRecordedSession(idSiteHsr, idLogHsr)[没有可用的例子]
-HeatmapSessionRecording.deleteRecordedSession(idSite, idSiteHsr, idVisit)[没有可用的例子]
-HeatmapSessionRecording.deleteRecordedPageview(idSiteHsr, idLogHsr)[没有可用的例子]
-HeatmapSessionRecording.getRecordedHeatmapMetadata(idSite，时间段，日期，idSiteHsr, segment = ")[没有可用的例子]
-HeatmapSessionRecording.getRecordedHeatmap(idSite, period, date, idSiteHsr, heatmapType, deviceType, segment = ")[没有可用的例子]
-HeatmapSessionRecording.getEmbedSessionInfo(idSiteHsr, idLogHsr)[没有可用的例子]
-
HeatmapSessionRecording.testUrlMatchPages(url, matchPageRules = '数组')
[示例]XML，Json，Tsv (Excel)］
-
HeatmapSessionRecording.getAvailableSessionRecordingSampleLimits（）
[示例]XML，Json，Tsv (Excel)］
模块ImageGraph
ImageGraph。get API调用可以为任何现有的Matomo报告生成漂亮的静态PNG图。支持的图形类型有:折线图、2D/3D饼图和垂直柱状图。关于可用参数的一些注意事项:
$graphType定义绘制图形的类型，可接受的值是:'evolution'， 'verticalBar'， 'pie'和'3dPie'
- $colors接受逗号分隔的颜色列表，将覆盖默认的Matomo颜色
-你也可以自定义宽度，高度，字体大小，正在绘制的指标(在情况下数据包含多列/指标)。另请参阅
如何嵌入静态图像图?获取更多信息。
-
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 = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块的见解
插件的API
-
Insights.getMoversAndShakersOverview(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Insights.getMoversAndShakers(idSite, period, date, reportUniqueId, segment = "， comparedToXPeriods = '1'， limitincrement = '4'， limitreducer = '4')[没有可用的例子]
-Insights.getInsights(idSite, period, date, reportUniqueId, segment = "， limitincrement = '5'， limitreducer = '5'， filterBy = "， minImpactPercent = '2'， minGrowthPercent = '20'， comparedToXPeriods = '1'， orderBy = 'absolute')[没有可用的例子]
模块LanguagesManager
LanguagesManager API允许您访问现有的Matomo翻译，并更改用户的语言首选项。"getTranslationsForLanguage"将返回给定语言的所有翻译字符串，因此您可以在应用程序中利用Matomo翻译(并自动受益于
40 +翻译!)这对于在自己的应用程序中集成Matomo API结果的开发人员非常有用。你也可以通过"getLanguageForUser"请求为用户加载默认语言，或者通过"setLanguageForUser"更新默认语言。
-
LanguagesManager.getAvailableLanguagesInfo(excludenoncopluugins = '1')
[示例]XML，Json，Tsv (Excel)］
-LanguagesManager.getLanguageForUser(登录)[没有可用的例子]
-LanguagesManager.setLanguageForUser(languageCode登录)[没有可用的例子]
-LanguagesManager.uses12HourClockForUser(登录)[没有可用的例子]
-LanguagesManager.set12HourClockForUser(use12HourClock登录)[没有可用的例子]
模块生活
生活!API允许您访问关于访问者的完整访问级别信息。结合的力量
分割，你将可以按任何标准要求访问。方法“getLastVisitsDetails”将为每次访问返回广泛的数据，其中包括:服务器时间，visitId, visitorId, visitorType(新的或返回的)，页数，所有页面的列表(和事件，文件下载和外链接点击)，自定义变量名称和值设置为这次访问，目标转换的数量(和所有目标转换的列表为这次访问，转换时间，收入，URL等)，但也有其他属性，如:距离上次访问的天数，距离第一次访问的天数，国家，大陆，访问者IP，提供商，使用的推荐人(推荐人名称，如果是搜索引擎，关键字，完整的URL)，活动名称和关键字，操作系统，浏览器，屏幕类型，分辨率，支持的浏览器插件(flash, java, silverlight, pdf等)，各种日期和时间格式，使API用户更容易……和更多!使用参数
”段= '你可以过滤回访的任何标准(访客IP，访客ID，国家，使用的关键字，一天的时间等)。方法“getCounters”用于返回一个简单的计数器:在过去N分钟内的访问量、操作数量、转换的访问量。另请参阅有关文档
实时小部件和访问者级别报告在Matomo。
-
Live.getCounters(idSite, lastMinutes, segment = "， showColumns = 'Array'， hideColumns = 'Array')
[示例]XML，Json，Tsv (Excel)］
-
Live.getLastVisitsDetails(idSite, period = "， date = "， segment = "， countVisitorsToFetch = "， minTimestamp = "， flat = "， doNotFetchActions = "， enhanced = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Live.getVisitorProfile(idSite, visitorId = "， segment = "， limitvisitors = ")
[示例]XML，Json，Tsv (Excel)］
登录模块
插件登录API
模块MarketingCampaignsReporting
插件营销活动报告的API
-
MarketingCampaignsReporting.getId(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MarketingCampaignsReporting.getName(idSite，时间段，日期，segment = "， expanded = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-MarketingCampaignsReporting.getKeywordContentFromNameId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-
MarketingCampaignsReporting.getKeyword(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MarketingCampaignsReporting.getSource(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MarketingCampaignsReporting.getMedium(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MarketingCampaignsReporting.getContent(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MarketingCampaignsReporting.getGroup(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MarketingCampaignsReporting.getPlacement(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MarketingCampaignsReporting.getSourceMedium(idSite，时间段，日期，segment = "， expanded = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-MarketingCampaignsReporting.getNameFromSourceMediumId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
模块MediaAnalytics
MediaAnalytics API允许您请求有关您的视频和音频如何在您的网站和应用程序上被访问和查看的报告。一些方法返回实时信息(类似于Live!API)，而其他返回你所有的视频和音频及其关键指标。
实时方法可以返回关于最近N分钟(或最近N小时)的信息。其中包括:
- 该方法
getCurrentNumPlays返回最近N分钟内视频播放(和音频播放)的次数
- 该方法
getCurrentSumTimeSpent返回用户在最近N分钟内播放媒体的总时间
- 该方法
getCurrentMostPlays返回最近N分钟内最受欢迎的视频。
其他方法返回视频和音频的聚合分析报告:
MediaAnalytics.get返回你的视频和音频的总体指标:Nb_plays、nb_unique_visitors_plays、nb_impressions、nb_unique_visitors_impressions、nb_finished、sum_total_time_watched、sum_total_audio_plays、sum_total_audio_impressions、sum_total_video_plays、sum_total_video_impressions、play_rate、finish_rate、印象_rate．getVideoTitles而且getAudioTitles按视频标题和音频标题返回视频/音频列表。getGroupedVideoResources而且getGroupedAudioResources返回按资源URL分组的观看视频/音频列表。“分组媒体资源”报告显示的是一个平面报告，其中包括媒体资源的域和路径，而常规的“媒体资源”报告则按域显示媒体资源的分层视图。getVideoHours而且getAudioHours按小时返回视频/音频列表(以查看您的媒体在一天中不同时间的消费情况)。getVideoTitles而且getAudioTitles按视频标题和音频标题返回视频/音频列表。getVideoResolutions按播放器分辨率返回视频列表(查看当视频分辨率变化时视频是如何被消耗的)。getPlayers通过媒体播放器返回所观看的媒体。
-
MediaAnalytics.getCurrentNumPlays(idSite, lastMinutes, segment = ")
[示例]XML，Json，Tsv (Excel)］
-
MediaAnalytics.getCurrentSumTimeSpent(idSite, lastMinutes, segment = ")
[示例]XML，Json，Tsv (Excel)］
-
MediaAnalytics.getCurrentMostPlays(idSite, lastMinutes, filter_limit = '5'， segment = ")
[示例]XML，Json，Tsv (Excel)］
-
MediaAnalytics.getVideoResources(idSite, period, date, segment = "， idSubtable = "， secondaryDimension = "， expanded = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MediaAnalytics.getAudioResources(idSite, period, date, segment = "， idSubtable = "， secondaryDimension = "， expanded = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MediaAnalytics.getVideoTitles(idSite，时间段，日期，segment = "， idSubtable = "， secondaryDimension = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MediaAnalytics.getAudioTitles(idSite，时间段，日期，segment = "， idSubtable = "， secondaryDimension = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MediaAnalytics.getGroupedVideoResources(idSite，时间段，日期，segment = "， idSubtable = "， secondaryDimension = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MediaAnalytics.getGroupedAudioResources(idSite，时间段，日期，segment = "， idSubtable = "， secondaryDimension = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MediaAnalytics.getVideoResolutions(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块MobileMessaging
MobileMessaging API可以让您管理和访问所有MobileMessaging插件功能，包括:-管理SMS API凭据-激活电话号码-检查剩余积分-发送SMS
-MobileMessaging.setSMSAPICredential(provider, credentials = 'Array')[没有可用的例子]
-MobileMessaging.addPhoneNumber(phoneNumber)[没有可用的例子]
-MobileMessaging.removePhoneNumber(phoneNumber)[没有可用的例子]
-MobileMessaging.validatePhoneNumber(verificationCode phoneNumber)[没有可用的例子]
-MobileMessaging.setDelegatedManagement(delegatedManagement)[没有可用的例子]
模块MultiChannelConversionAttribution
多通道转换属性API
-MultiChannelConversionAttribution.setGoalAttribution(idSite, idGoal, isEnabled)[没有可用的例子]
-MultiChannelConversionAttribution.getGoalAttribution(idSite idGoal)[没有可用的例子]
-MultiChannelConversionAttribution.getChannelAttribution(idSite，时间段，日期，idGoal, numDaysPriorToConversion = "， segment = "， expanded = "， flat = "， idSubtable = ")[没有可用的例子]
-
MultiChannelConversionAttribution.getAvailableNumDaysPriorConversion（）
[示例]XML，Json，Tsv (Excel)］
-
MultiChannelConversionAttribution.getSiteAttributionGoals(idSite)
[示例]XML，Json，Tsv (Excel)］
模块多点
MultiSites API允许您请求Matomo中所有网站的关键指标(访问，页面视图，收入)。
-
MultiSites.getAll(period, date, segment = "， enhanced = "， pattern = "， showColumns = 'Array')
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
MultiSites.getAllWithGroups(时间= "、日期= "段= = "模式,filter_limit = ' 0 ')
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块覆盖
类的API
模块PagePerformance
模块PrivacyManager
插件PrivacyManager的API
-PrivacyManager.deleteDataSubjects(访问)[没有可用的例子]
-PrivacyManager.exportDataSubjects(访问)[没有可用的例子]
-PrivacyManager.findDataSubjects(idSite段)[没有可用的例子]
-
PrivacyManager.anonymizeSomeRawData(idSites, date, anonymizeIp = "， anonymizeLocation = "， anonymizeUserId = "， unsetVisitColumns = 'Array'， unsetLinkVisitActionColumns = 'Array'， passwordConfirmation = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块反向链接
推荐人API可以让您访问有关网站，搜索引擎，关键字，用于访问您的网站的活动的报告。例如，"getKeywords"返回所有搜索引擎关键字(包含
一般分析指标对于每个关键字)，"getWebsites"返回推荐者网站(如果设置了&expanded=1参数，则会返回完整的推荐者URL)。"getReferrerType"返回Referrer概述报告。"getCampaigns"返回所有活动的列表(如果设置了&expanded=1参数，则返回所有活动的关键字)。
-
Referrers.getReferrerType(idSite, period, date, segment = "， typeReferrer = "， idSubtable = "， expanded = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Referrers.getKeywords(idSite，时间段，日期，segment = "， expanded = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Referrers.getSearchEnginesFromKeywordId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-
Referrers.getSearchEngines(idSite，时间段，日期，segment = "， expanded = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Referrers.getKeywordsFromSearchEngineId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-Referrers.getKeywordsFromCampaignId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-
Referrers.getWebsites(idSite，时间段，日期，segment = "， expanded = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Referrers.getUrlsFromWebsiteId(idSite，时间段，日期，idSubtable, segment = ")[没有可用的例子]
-
Referrers.getSocials(idSite，时间段，日期，segment = "， expanded = "， flat = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Referrers.getUrlsForSocial(idSite，时间段，日期，segment = "， idSubtable = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Referrers.getNumberOfDistinctSearchEngines(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Referrers.getNumberOfDistinctSocialNetworks(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Referrers.getNumberOfDistinctKeywords(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Referrers.getNumberOfDistinctCampaigns(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Referrers.getNumberOfDistinctWebsites(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
Referrers.getNumberOfDistinctWebsitesUrls(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块的决议
模块RollUpReporting
插件rollupreports的API
-RollUpReporting.addRollUp(名称，sourceIdSites，时区，货币)[没有可用的例子]
-
RollUpReporting.updateRollUp(idSite, name = "， sourceIdSites = "，时区= "，货币= ")
[示例]XML，Json，Tsv (Excel)］
模块搜索引擎优化
SEO API可以让您访问指定URL的SEO指标列表:谷歌PageRank，谷歌/必应索引页面和域名的年龄。
模块ScheduledReports
ScheduledReports API允许您管理定时电子邮件报告，以及生成，下载或电子邮件任何现有的报告。"generateReport"将生成所请求的报告(针对特定的日期范围、网站和所请求的语言)。"sendReport"将通过电子邮件将报告发送给此报告指定的收件人。您还可以通过“getReports”获取所有现有报告的列表，通过“addReport”创建新报告，或者使用“updateReport”和“deleteReport”管理现有报告。另请参阅有关文档
定时邮件报表在Matomo。
-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 = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-ScheduledReports.generateReport(idReport, date, language = "， outputType = "， period = "， reportFormat = "， parameters = ")[没有可用的例子]
-ScheduledReports.sendReport(idReport, period = "， date = "， force = ")[没有可用的例子]
模块SearchEngineKeywordsPerformance
的
SearchEngineKeywordsPerformanceAPI可以让你从谷歌，Bing & Yahoo和Yandex下载所有的SEO搜索关键字，以及获得搜索机器人如何抓取你的网站和他们可能遇到的任何错误的详细概述。
1)下载你在谷歌，Bing & Yahoo和Yandex上搜索的所有搜索关键字。这包括谷歌图像，谷歌视频和谷歌新闻。这可以让您查看所有关键字通常隐藏在“关键字未定义”后面的视图。有了这个插件，你可以看到他们所有!
2)从Bring、Yahoo和谷歌下载所有的爬行统计数据和指标。许多指标可用，如:抓取页面，抓取错误，连接超时，http -状态代码301(永久移动)，http -状态代码400-499(请求错误)，所有其他http -状态代码，索引页总数，Robots.txt排除，DNS失败，http -状态代码200-299,http -状态代码301(临时移动)，http -状态代码500-599(内部服务器错误)，恶意软件感染网站，入站链接总数。\ Plugins \ SearchEngineKeywordsPerformance
-
SearchEngineKeywordsPerformance.getKeywordsGoogleImage(idSite，时间段，日期)
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
SearchEngineKeywordsPerformance.getKeywordsGoogleVideo(idSite，时间段，日期)
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
SearchEngineKeywordsPerformance.getKeywordsGoogleNews(idSite，时间段，日期)
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
SearchEngineKeywordsPerformance.getCrawlingOverviewBing(idSite，时间段，日期)
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
SearchEngineKeywordsPerformance.getCrawlingOverviewYandex(idSite，时间段，日期)
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
SearchEngineKeywordsPerformance.getCrawlingErrorExamplesBing(idSite)
[示例]XML，Json，Tsv (Excel)］
模块SegmentEditor
SegmentEditor API允许您添加、更新、删除自定义段，并列出保存的段。
-SegmentEditor.delete(idSegment)[没有可用的例子]
-SegmentEditor.update(idSegment, name, definition, idSite = "， autoArchive = "， enabledAllUsers = ")[没有可用的例子]
-SegmentEditor.add(name, definition, idSite = "， autoArchive = "， enabledAllUsers = ")[没有可用的例子]
-SegmentEditor.get(idSegment)[没有可用的例子]
模块SitesManager
SitesManager API让您在Matomo中完全控制网站(创建，更新和删除)，以及基于各种属性检索网站的许多方法。这个API可以让你通过“addSite”创建网站，通过“updateSite”更新现有网站，通过“deleteSite”删除网站。当创建网站时，它可以通过“getCurrencyList”访问Matomo使用的货币内部代码，或通过“getTimezonesList”访问时区。也有许多方法来请求一个网站列表:从网站ID通过“getSiteFromId”或网站URL通过“getSitesIdFromSiteUrl”。通常，最有用的技术是列出当前用户已知的所有网站，基于token_auth，通过"getSitesWithAdminAccess"， "getSitesWithViewAccess"或"getSitesWithAtLeastViewAccess"(返回两者)。一些方法将影响全局所有网站:“setGlobalExcludedIps”将设置ip列表，排除在所有网站上，“setGlobalExcludedQueryParameters”将设置URL参数列表，从所有网站的URL中删除。现有的值可以通过“getExcludedIpsGlobal”和“getExcludedQueryParametersGlobal”来获取。另请参阅有关文档
管理网站在Matomo。
-
SitesManager.getJavascriptTag(idSite, piwikUrl = "， mergeSubdomains = "， groupPageTitlesByDomain = "， mergeAliasUrls = "， visitorCustomVariables = "， pageCustomVariables = "， customcampaigns namequeryparam = "， customcampaigns keywordparam = "， doNotTrack = "， disableCookies = "， trackNoScript = "， crossDomain = "， forceMatomoEndpoint = "， excludedQueryParams = "， excludedReferrers = ")
[示例]XML，Json，Tsv (Excel)］
-
SitesManager.getImageTrackingCode(idSite, piwikUrl = "， actionName = "， idGoal = "， revenue = "， forceMatomoEndpoint = ")
[示例]XML，Json，Tsv (Excel)］
-
SitesManager.getSitesWithAdminAccess(fetchAliasUrls = "， pattern = "， limit = "， sitesToExclude = 'Array')
[示例]XML，Json，Tsv (Excel)］
-SitesManager.addSite(siteName, urls = "， ecommerce = "， siteSearch = "， searchKeywordParameters = "， searchCategoryParameters = "， excludedIps = "， excludedQueryParameters = "， timezone = "， currency = "， group = "， startDate = "， excludedUserAgents = "， keepURLFragments = "， type = "， settingValues = "， excludeUnknownUrls = "， excludedReferrers = ")[没有可用的例子]
-SitesManager.deleteSite(idSite, passwordConfirmation = ")[没有可用的例子]
-SitesManager.addSiteAliasUrls(idSite url)[没有可用的例子]
-SitesManager.getIpsForRange(ipRange)[没有可用的例子]
-SitesManager.setGlobalExcludedIps(excludedIps)[没有可用的例子]
-SitesManager.setGlobalSearchParameters(searchKeywordParameters searchCategoryParameters)[没有可用的例子]
-SitesManager.setGlobalExcludedUserAgents(excludedUserAgents)[没有可用的例子]
-SitesManager.setGlobalExcludedReferrers(excludedReferrers)[没有可用的例子]
-SitesManager.setKeepURLFragmentsGlobal(启用)[没有可用的例子]
-SitesManager.setGlobalExcludedQueryParameters(excludedQueryParameters)[没有可用的例子]
-SitesManager.setDefaultCurrency(defaultCurrency)[没有可用的例子]
-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.getTimezoneName(timezone, countryCode = "， multipleTimezonesInCountry = ")[没有可用的例子]
-SitesManager.renameGroup(oldGroupName newGroupName)[没有可用的例子]
-SitesManager.getPatternMatchSites(pattern, limit = "， sitesToExclude = 'Array')[没有可用的例子]
模块TagManager
插件标签管理器的API。允许您配置所有容器，创建、更新和删除标记、触发器和变量。创建和发布新版本，启用和禁用预览/调试模式，等等。请注意:一个容器可能有几个版本。用户正在编辑的当前版本称为“草稿”版本。你可以通过调用{@link TagManager.getContainer}来获取“draft”版本的ID。
-
TagManager.getAvailableEnvironmentsWithPublishCapability(idSite)
[示例]XML，Json，Tsv (Excel)］
-TagManager.getAvailableTagTypesInContext(idContext)[没有可用的例子]
-TagManager.getAvailableTriggerTypesInContext(idContext)[没有可用的例子]
-TagManager.getAvailableVariableTypesInContext(idContext)[没有可用的例子]
-TagManager.getContainerEmbedCode(idSite, idContainer, environment)[没有可用的例子]
-TagManager.getContainerInstallInstructions(idSite, idContainer, environment)[没有可用的例子]
-TagManager.getContainerTags(idSite, idContainer, idContainerVersion)[没有可用的例子]
-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.addContainer(idSite, context, name, description = ")[没有可用的例子]
-TagManager.updateContainer(idSite, idContainer, name, description = ")[没有可用的例子]
-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.exportContainerVersion(idSite, idContainer, idContainerVersion = ")[没有可用的例子]
-TagManager.importContainerVersion(exportedContainerVersion, idSite, idContainer, backupName = ")[没有可用的例子]
模块之旅
API的旅游插件，帮助您熟悉Matomo。
-Tour.skipChallenge(id)[没有可用的例子]
模块的转换
-Transitions.getTransitionsForPageTitle(pageTitle, idSite, period, date, segment = "， limitBeforeGrouping = '0')[没有可用的例子]
-
Transitions.getTransitionsForPageUrl(pageUrl, idSite, period, date, segment = "， limitBeforeGrouping = '0')
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-Transitions.getTransitionsForAction(actionName, actionType, idSite, period, date, segment = "， limitBeforeGrouping = '0'， parts = 'all')[没有可用的例子]
模块TwoFactorAuth
-TwoFactorAuth.resetTwoFactorAuth(userLogin passwordConfirmation)[没有可用的例子]
模块UserCountry
用户国家API允许您访问有关访问者国家和大洲的报告。
-UserCountry.setLocationProvider(providerId)[没有可用的例子]
-
UserCountry.getNumberOfDistinctCountries(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块用户标识
插件UserId的API。允许获取用户id表。
模块UserLanguage
UserLanguage API允许您访问有关访问者语言设置的报告
模块UsersFlow
用户流的API。API可以让您了解用户或访问者如何浏览您的网站的细节。
-
UsersFlow.getUsersFlowPretty(idSite, period, date, segment = "， expanded = "， flat = "， idSubtable = "， dataSource = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
UsersFlow.getUsersFlow(idSite, period, date, limitActionsPerStep = '5'， exploreStep = "， exploreUrl = "， segment = "， expanded = "， dataSource = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-UsersFlow.getInteractionActions(idSite, period, date, interactionPosition, offsetActionsPerStep = "， segment = "， idSubtable = "， dataSource = ")[没有可用的例子]
模块UsersManager
UsersManager API允许您管理用户及其访问特定网站的权限。您可以通过addUser创建用户，通过updateUser更新已有用户，通过deleteUser删除用户。有很多方法来列出用户基于他们的登录“getUser”和“getUsers”，他们的电子邮件“getUserByEmail”，或哪些用户有权限(视图或管理)访问指定的网站“getUsersWithSiteAccess”。现有的权限被列出通过“getSitesAccessFromUser”登录，或通过“getUsersAccessFromSite”网站ID，或者你可以列出所有用户和网站通过“getUsersSitesFromAccess”给定的权限。权限的设置和更新通过方法“setUserAccess”。另请参阅有关文档
管理用户在Matomo。
-UsersManager.setUserPreference(userLogin, preferenceName, preferenceValue)[没有可用的例子]
-UsersManager.getUserPreference(preferenceName, userLogin = ")[没有可用的例子]
-
UsersManager.getUsersPlusRole(idSite, limit = "， offset = '0'， filter_search = "， filter_access = "， filter_status = ")
[示例]XML，Json，Tsv (Excel)］
-
UsersManager.getSitesAccessForUser(userLogin, limit = "， offset = '0'， filter_search = "， filter_access = ")
[示例]XML，Json，Tsv (Excel)］
-UsersManager.getUserByEmail(userEmail)[没有可用的例子]
-UsersManager.addUser(userLogin, password, email, initialIdSite = "， passwordConfirmation = ")[没有可用的例子]
-
UsersManager.inviteUser(userLogin, email, initialIdSite = "， expiryInDays = "， passwordConfirmation = ")
[示例]XML，Json，Tsv (Excel)］
-UsersManager.setSuperUserAccess(userLogin, hasSuperUserAccess, passwordConfirmation = " ")[没有可用的例子]
-UsersManager.updateUser(userLogin, password = "， email = "， passwordConfirmation = ")[没有可用的例子]
-UsersManager.deleteUser(userLogin, passwordConfirmation = ")[没有可用的例子]
-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.resendInvite(userLogin, expiryInDays = '7'， passwordConfirmation = ")
[示例]XML，Json，Tsv (Excel)］
-
UsersManager.generateInviteLink(userLogin, expiryInDays = '7'， passwordConfirmation = ")
[示例]XML，Json，Tsv (Excel)］
模块VisitFrequency
VisitFrequency API允许您访问与回访访问者相关的指标列表。
模块VisitTime
VisitTime API允许您按小时(服务器时间)和按小时访问您的访问者的本地时间访问报告。
-
VisitTime.getVisitInformationPerLocalTime(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
VisitTime.getVisitInformationPerServerTime(idSite，时间段，日期，segment = "， hideFutureHoursWhenToday = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块VisitorInterest
VisitorInterest API允许您访问两个访问者参与度报告:每页数的访问数，以及每次访问持续时间的访问数。
-
VisitorInterest.getNumberOfVisitsPerVisitDuration(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
VisitorInterest.getNumberOfVisitsPerPage(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
VisitorInterest.getNumberOfVisitsByDaysSinceLast(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
-
VisitorInterest.getNumberOfVisitsByVisitCount(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
模块VisitsSummary
VisitsSummary API允许您访问核心web分析指标(访问次数，独立访问者，操作计数(页面视图&下载&外链接点击)，在站点的时间，反弹和转换访问。
-
VisitsSummary.getSumVisitsLengthPretty(idSite, period, date, segment = ")
[示例]XML，Json，Tsv (Excel)，最后一个RSS10天］
