Timeseries of custom events using the stats API

[salomvary]

Hi folks,

I would like to use the stats API to get timeseries for pageviews and custom events.

For pageviews, this works fine:

GET https://plausible.io/api/v1/stats/timeseries?site_id={{SITE_ID}}&period=custom&date=2023-11-01,2023-11-07&metrics=pageviews&interval=date

However, this does not, for events (I get "** (CaseClauseError) no case clause matching: :events" back):

GET https://plausible.io/api/v1/stats/timeseries?site_id={{SITE_ID}}&period=custom&date=2023-11-01,2023-11-07&metrics=events&interval=date

...the error is reasonable, because events is not documented as possible metrics parameter of /timeseries, but I do not understand the reason. It works fine with /breakdown?metrics=events, which suggests the date is there, but not exposed.

Am I missing something? Is this a missing feature, and should I file a feature request or send a pull request? Or a limitation I am not aware of?

If there are other ways of getting a timeseries of custom events from the API, I'm all ears :)

Thanks!

[salomvary]

This is the answer we got ftom Plausible support:

It's not possible to query for the "events" metric in the timeseries endpoint, because you cannot get total pageviews + total custom events for a specific timeframe broken down by days. This is not possible in the dashboard either and the API follows the dashboard.

This is my attempt on a fix: #3505

[salomvary]

Events are now available in /timeseries.