Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New API query parameter that automatically includes dependent metrics in report output #21939

Closed
diosmosis opened this issue Feb 13, 2024 · 1 comment
Labels
c: APIs For bugs and features in the Matomo HTTP and plugin APIs. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org.

Comments

@diosmosis
Copy link
Member

diosmosis commented Feb 13, 2024

Summary

Refs matomo-org/looker-studio-connector#3
Refs matomo-org/looker-studio-connector#29
Refs #21937

In the Looker Studio connector, in order to support further grouping of processed metrics, the connector will need to be able to automatically query the metrics that processed metrics depend on.

For example, when querying for bounce_rate, the bounce_count and nb_visits need to be returned as well. With the metadata in #21937, we'll be able to tell Looker Studio how to compute bounce_rate, so the data to do that computation, must exist in the API response.

This is not the default behavior in Matomo. Normally, when a metric like bounce_rate is queried, the metrics needed to compute it will be queried from the database, but will be discarded after the computation is done. For Looker Studio, the connector needs a way to keep the discarded metrics.

A new query parameter in the Reporting API (eg, include_temporary_metrics=1) that provides this behavior is a possible solution.

@diosmosis diosmosis added Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. To Triage An issue awaiting triage by a Matomo core team member labels Feb 13, 2024
@michalkleiner michalkleiner added c: APIs For bugs and features in the Matomo HTTP and plugin APIs. and removed To Triage An issue awaiting triage by a Matomo core team member labels Feb 13, 2024
@michalkleiner michalkleiner added this to the For Prioritization milestone Feb 13, 2024
@diosmosis
Copy link
Member Author

This appears to already exist as showRawMetrics=1 (see DataTablePostProcessor::applyRequestedColumnDeletion()).

@sgiehl sgiehl added the not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: APIs For bugs and features in the Matomo HTTP and plugin APIs. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org.
Projects
None yet
Development

No branches or pull requests

3 participants