From 2458b31eead97e90bf70bc675ac340dd24e37cfb Mon Sep 17 00:00:00 2001 From: JLuc <443278+JLuc@users.noreply.github.com> Date: Tue, 26 Nov 2024 18:17:43 +0100 Subject: [PATCH] fix: period unit for 'range' Documentation should mention what parameter holds 'day', 'week', 'month' or 'year' when period is range. fixes #803 --- docs/5.x/reporting-api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/5.x/reporting-api.md b/docs/5.x/reporting-api.md index 1755b8214..71abfcf96 100644 --- a/docs/5.x/reporting-api.md +++ b/docs/5.x/reporting-api.md @@ -40,9 +40,9 @@ The APIs let you programmatically request any analytics reports from Matomo, for * _YYYY-MM-DD,YYYY-MM-DD_ for every period (day, week, month or year) in the date range * Note: if you set 'period=range' to request data for a custom date range, the API will return the sum of data for the specified date range. -When 'period=range', the following keywords are supported for the parameter 'date': +When 'period=range', the implicit period unit is 'day' and following keywords are supported for the parameter 'date': - * _lastX_ + * _lastX_ * _previousX_ * _YYYY-MM-DD,YYYY-MM-DD_, both dates can be replaced with magic keywords (the first one does not support _today_ and _yesterday_). eg. _YYYY-MM-DD,today_, _lastMonth,YYYY-MM-DD_ or _lastYear,lastWeek_