如何为 Matomo 构建正确的 HTTP API 调用

Question

我是使用 API 的新手，但一直在阅读它。我的任务是将数据从 API 导入 CSV 文件。我创建了一个有效的导入字符串（来自示例）。尽管阅读了documentation 页面和一个工作示例，但我还没有得到我需要工作的实际报告。

这是有效的字符串：

myURL = "https://admin.metrics.mysite.com/?module=API" _
& "&method=API.get&idSite=9&period=day&date=last30&format=tsv&translateColumnNames=1" _
& "&token_auth=" & myToken

我需要的是所有已下载文件的月度报告。

这是我的最后一次尝试（已经尝试了许多变体）：

Dim myToken As String
myToken = "secrettokenhere"
myURL = "https://admin.metrics.mysite.com/?module=API" _
    & "&method=API.getDownloads" _
    & "&idSite=9" _
    & "&period=day" _
    & "&date=2018-11-05" _
    & "&segement=''" _
    & "&expanded=''" _
    & "&idSubtable=''" _
    & "&flat=''" _
    & "&format=tsv" _
    & "&filter_limit=10" _
    & "&token_auth=" & myToken

当我运行它时，我得到的错误信息是这样的：

错误：方法“getDownloads”不存在或在 模块'\Piwik\Plugins\API\API'。

我被困在最基本的事情上...我使用的是正确的get 方法吗？我缺少参数吗？我做错了什么？

任何指针表示赞赏！

Answer 1

正如您在API reference 中看到的，该方法不是称为API.getDownloads，而是称为Actions.getDownloads。

现在我更了解您的问题，更详细：

您使用的 API 端点 (API.get) 为您提供每天的下载次数，我认为这不是您想要的。

获得正确端点的最简单方法（除了阅读API reference）是在 Matomo UI 中打开您需要的报告。 如果您想要所有下载的列表，这将是 Behaviour -> Downloads 报告。之后您可以点击表格下方的导出图标，它会显示正确的 API url。

在你的情况下，它现在是?module=API&method=Actions.getDownloads

如果您不想要目录，但想要一个平面列表，您可以添加&flat=1：?module=API&method=Actions.getDownloads&flat=1。

这应该返回你想要的（也许还添加&filter_limit=-1 以获取无限的结果）。