read_matomo_data: Read data from Matomo API

In statistikZH/statZHmatomo: Connect to Matomo Web Analytics Reporting API

Read data from Matomo API

Description

read_matomo_data reads data from Matomo Reporting HTTP API for available methods.

A method is a combined API Module and API Action.

Usage

read_matomo_data(
  connection = NULL,
  apiModule = NULL,
  apiAction = NULL,
  idDimension = NULL,
  date = "yesterday",
  period = "day",
  format = "csv",
  processed_report = FALSE,
  idSubtable = NULL,
  pageUrl = NULL,
  pageTitle = NULL
)

Arguments

connection	A connection object created by the set_matomo_server() function.
apiModule	A character vector of an API Module from the Reporting API Method List
apiAction	A character vector of an API Action for the selected API Module
idDimension	A numeric vector of the Custom Dimension
date	A date in standard ISO 8601 format YYYY-MM-DD. Magic character vector keywords are "today" or "yesterday".
period	Period you request the statistics for. Can be any of: day, week, month, year or range. All reports are returned for the dates based on the website's time zone.
format	A character vector to define the output format as CSV, XML or JSON
processed_report	A logical that controls whether the method "getProcessedReport" is used for the API Action and Module. The method will return a human readable version of any other report, and include the processed metrics such as conversion rate, time on site, etc. which are not directly available in other methods.
idSubtable	A numeric vector to identify a subtable. Only valid when processed_report = TRUE.
pageUrl	A character vector to identify the target url of a page. Only required for certain actions (documented in the Matomo API reference).
pageTitle	A character vector to identify the target title of a page. Only required for certain actions (documented in the Matomo API reference).

Value

The output will be a data of the selected format

Examples

conObj<-set_matomo_server()
read_matomo_data(
connection = conObj,
apiModule = "Actions", apiAction = "getPageUrls"
)

## Not run: 
read_matomo_data()

## End(Not run)

statistikZH/statZHmatomo documentation built on Oct. 3, 2023, 11:03 p.m.