man/matomoQuery.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/matomoquery.R
\name{matomoQuery}
\alias{matomoQuery}
\title{Get reports from a matomo API server}
\usage{
matomoQuery(
  matomoUrl,
  siteId,
  period = "month",
  date = "last16",
  filter_limit = 500,
  removeFirst = FALSE,
  removeLast = FALSE,
  accessToken = getAccessToken(matomoUrl),
  getMethod = "VisitsSummary.get",
  ignoreEmptyResult = FALSE
)
}
\arguments{
\item{matomoUrl}{base URL of your matomo instance}

\item{siteId}{matomo site id or vector of site ids}

\item{period}{\code{day}, \code{week}, \code{month} or \code{year}}

\item{date}{date range (see \url{https://developer.matomo.org/api-reference/reporting-api})}

\item{filter_limit}{defines the maximum number of rows to be returned}

\item{removeFirst}{logical that determines whether the first row of each site should be removed (to account for incomplete periods)}

\item{removeLast}{logical that determines whether the last row of each site should be removed (to account for incomplete periods)}

\item{accessToken}{API Authentication Token - you can get this in your
matomo interface under Settings -> Personal -> Settings -> API Authentication Token
and pass it here, or you can make it persistent with \code{\link{persistAccessToken}}.}

\item{getMethod}{API method to call – default: VisitsSummary.get}

\item{ignoreEmptyResult}{if FALSE stop with error message on empty list results, otherwise return empty list}
}
\value{
Data frame with visits summary as returned by matomo. Note that the \code{date} column in the returned data frame refers to the first day of the respective period.
}
\description{
See matomo Reporting API Reference (\url{https://developer.matomo.org/api-reference/reporting-api}) for details.
}
\examples{
\dontrun{
df <- matomoQuery("https://demo.matomo.org/", getMethod = "UserCountry.getCountry")
}

}
\references{
\url{https://developer.matomo.org/api-reference/reporting-api}
}