usageStats custom reports

Software Support
, ,
1

We do not know how we can create custom reports and charts using data collected by usageStats plugin.

We activated the plugin, it works. We would like to have custom charts, maps and reports calculated on collected data. We have our installation outsourced in a service provider, hence we cannot easily access collected data. To be specific, it would be great for us to display various maps with accesses per country. We do not know how to access the collected data.

Is there any API to query usageStats collected data? Is there some configuration to activate usageStats API? We would be grateful if you could suggest us any other method to access those collected data remotely. Any hint is greatly appreciated.

We are using OJS 3.2 and passing to 3.3 this month.

2

Hi @joelfan,

Please see here for our documentation on statistics/reporting: https://docs.pkp.sfu.ca/admin-guide/en/statistics

This wouldn’t include things like custom charts, maps, and reports - often users make use of external web analytics for such things, such as Matomo or similar platforms.

-Roger
PKP Team

4

Hi @rcgillis , thanks for infos, we will have a look to matomo.
Regarding OJS/OMP APIs, do you know why country is not included, and eventually if is possible to include it?
Best regards
Stefano

5

Hi @bolelligallevi

I’m not sure what you mean by this:

6

Hi @rcgillis, regional data can be tracked according this par of documentation, but I can’t understand if such data- when tracked - can be obtained by API.
In other words, I can’t find regional data (country in particular) in Stats / Publications part of API documentation (https://docs.pkp.sfu.ca/dev/api/ojs/3.3#tag/Stats-Publications).
Best regards
Stefano

7

Hi @bolelligallevi,

Thanks for clarifying. I don’t know off-hand, but I’ll see if another one of our team members can weigh in.

-Roger
PKP Team

8

No, it is not available through the REST API in 3.3. Geographical data will be available in CSV form through the REST API in the next major version (3.4, scheduled for release in 2023).

1 Like
9

Hi @NateWr, thanks for your answer.
For now, is it possible to query the db for geographical data?
If yes, how?
We saw that country data is in a usage_stats_temporary_table table, but we do not understand the mening of all fields, e.g. assoc_id and assoc_type
Can you give any hint?
Best regards
Stefano

immagine

11

Hi @bolelligallevi,

The main DB table for usage stats is metrics. You could e.g. then query everything (or e.g. only abstract views and file downloads), grouping by country, region, and/or city.
You can eventually also use the custom report generator to get the data in CSV format.

Let me know if I can help further…
Best,
Bozana

12

Thanks @bozana.
We are now in 3.3.
Can you or @NateWr confirm that Geographical data are now available in 3.4 REST API?
Thanks a lot.

13

Hi @joelfan,
Yes, please see the API documentation, e.g. https://docs.pkp.sfu.ca/dev/api/ojs/3.4#tag/Stats-Publications/paths/~1stats~1publications~1countries/get.
Maybe also helpful: https://docs.pkp.sfu.ca/admin-guide/en/statistics#geography.

Best,
Bozana

14

Thx a lot.

Thanks also for the second link (https://docs.pkp.sfu.ca/admin-guide/en/statistics#geography). It is only for 3.4, we suppose. I cannot find this feature in 3.3