umami-software/website

Some API doc/sample seems not up-to-date

Opened this issue · 0 comments

Hi,
following umami 2.9.0 study, I encounter some diff between doc and real endpoints.
Maybe some update of the doc are needed.

(source: boly38/umami-api-client#17)

doc: https://umami.is/docs/api

  • auth - ok
  • users - GET : 405 (that's maybe because I didnt use this feature)
  • teams or websites - GET response structure
{
  "data": [],
  "count": 0,
  "page": 1,
  "pageSize": 10,
  "orderBy": "name"
}

=> ⚠️ data level is not reported in umami doc ?

in https://umami.is/docs/website-stats

  • error in first : /active uses /stats as example (we expect a /active as example)
  • and there is no details on /stats

Bonus: in order to retrieve this website repository, it could be great to add in the footer a link to the website repository in addition to the "umami" core one (out of mistake from me, I didn't find it quickly) - or that could be inline link "improve me..." button for example.