Stats API - add a more flexible filter for page paths

[RobertJoonas]

With Stats API, It's currently not possible to pull data from all pages that start with, say "/article/". A simple "that_contains" option would do the trick, but a regex filter would be the best.

(feedback via email)

UPDATE: This is now live!

[hadley]

Or just support the same syntax that the app uses for filtering, e.g. {"page":"/blog/**"}

[luctus]

Hello @metmarkosaric,

Do we have any updates on this? thanks!

[metmarkosaric]

Hey @luctus! There are no updates on this and no short term plans that I can tell you about. We are focused on the more frequently requested features such as export/import at the moment. We'd like to build this but we are a small team with limited development resources so need to focus on most frequently requested features one at a time. Thanks for understanding!

[luctus]

Totally understandable. Thanks for the fast reply!

cheers!

[wladpaiva]

This seems like a really low priority for you guys. Could we have at least some directions on where this should be implemented in case we open a PR?

[mquandalle]

It seems to work : ?event:page==/path/**

[RobertJoonas]

Apologies everyone! It seems like we've missed updating this thread. I can see this was added 8 months ago by @ukutaht in 0a5f6c5.

I can confirm that the Stats API does support the same wildcard filtering that we have in the dashboard.

[metmarkosaric]

oh wow! thanks for checking! i've been telling people it's not live yet 😱

[metmarkosaric]

@RobertJoonas could you explain this use case in the stats API docs please? you can use some of the same info that we have here: https://plausible.io/docs/pageview-goals#pageview-goals-support-wildcards. thanks!

[wladpaiva]

Weird. This doesn't:

{{BASE_URL}}/api/v1/stats/aggregate?site_id=eatingdots.com&filters=event:page==/bolos-de-julieta**

I'm using the docker version plausible/analytics:latest updated 5 days ago so I'm assuming I've got the correct version

[luctus]

I understand these wildcards only work when creating page goals, not in the stats api, sadly.

[luctus]

I just tested it in production and it worked! I wasn't aware of it, I will update my app right now.

Anyway, you need to encode that url, so it should be something like this:

{{BASE_URL}}/api/v1/stats/aggregate?site_id=eatingdots.com&filters=event%3Apage%3D%3D%2Fbolos-de-julieta**

[wladpaiva]

I could definitely be doing something wrong but it looks like it only works for the web app but not for the API. It didn't like the encoded version version though. Are you running on the most recent version?

[luctus]

That's weird. You are using the cloud version, right? If you want, you can test it in dailytics.com and I can see the logs to see the exact query string

[wladpaiva]

I'm using the Self-hosted. Good idea!

[RobertJoonas]

Clarifying here, that this feature did not make it to the latest self-hosted release. At this stage, wildcards are only supported on the official cloud-hosted version.

Self-hosted is not updated as frequently as the hosted version which changes daily so the latest features won’t be immediately available. Think of it as a long-term release - we stack all the new features and fixes that have been battle tested on the hosted version. We'd like to release a new self-hosted version soon but cannot make any strict promises. Thanks for understanding!

[wladpaiva]

@RobertJoonas Totally understandable. It just doesn't make sense because if the feature wasn't available already in the self-hosted I shouldn't be able to use it on the web app. Right?
This is not the case, the feature works 100% on the self-hosted web app. Shouldn't the web app be using the same API as I do?

[RobertJoonas]

@wladiston

It just doesn't make sense because if the feature wasn't available already in the self-hosted I shouldn't be able to use it on the web app. Right?

Not quite. Dashboard wildcard filtering is supported from version 1.4.0 (Oct 27, 2021). Filtering in Stats API works somewhat differently than the dashboard, and wildcard filtering wasn't included in the API at that time.

So in the current self-hosted release, you can use wildcards in the dashboard, but not in Stats API. Hope this makes sense.

[polman4]

Hello, any update for this?

[danielegaliffa]

Hello, is there a possibility to use a regular expression filter with the STATs API to select pages that do not contain a specific string?

Thanks