Understanding our users' usage of the API

[robredpath]

Hi @cormachallinanderilinx

Building on #450 we'd like to understand more about how our users use the APIs. This is a bit of a blind spot for us in terms of understanding our users.

I understand that you're currently working to understand how many users are using API Keys vs how many are using API Tokens to authenticate.

If there's any way to understand which parts of the API they're using, and how often, that would be very useful insight for us.

[robredpath]

@cormachallinanderilinx has been sending me updates via email of users using API Keys vs Tokens.

So far, most API Keys users have been AidStream and IATI Publisher users. I've therefore been in touch with Young Innovations to make the relevant arrangements with them.

There's a handful of others, who I'll contact directly in due course.

[robredpath]

After discussion with @cormachallinanderilinx I've clarified that this isn't related to authentication; a report from the nginx proxy logs of all of the URLs that start with /api and a count of their usage over time would be ideal

[robredpath]

@cormachallinanderilinx have we started to get any data from this?

[robredpath]

Alternatively, could we get nginx to send logs to a remote server (as well as local) so that we can conduct our own analysis? We're happy to set something up on our end to receive them (e.g. rsyslog). That might be easier in the medium term. Let me know @cormachallinanderilinx !

[cormachallinanderilinx]

Hi @robredpath
We are looking at building (probably a script) that will take logs from our logging server which match somehting like /api/
We will then anonymise them and we can then send the information over to ye

[robredpath]

Ah, amazing - thanks @cormachallinanderilinx !

[robredpath]

Hi @cormachallinanderilinx - is there any news on this? I could really do with some stats to mix in with our web analytics and usage data from our other APIs as we get towards the end of year reporting season; I understand it will only be for a short period but I'm keen to have a more well-rounded picture in place as we head into 2025.