IQSS / IQSS/dataverse

Metrics API: ability to exclude sub-collections

Open
#10,752 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request
As a Metrics API User,
When retrieving metrics for a dataverse collection (with or without parentAlias),
I can filter out the sub collections,
So that I can retrieve metrics only on a specific collection.

What kind of user is the feature intended for?
Metrics API User

What inspired the request?
Here is the organization of (some of) our collections:
inrae-collections
The green ones are managed by the central support team and the red ones by others.
In this case we would like to follow the datasets published for the green collections for the central support team.

Any brand new behavior do you want to add to Dataverse?
Add a boolean parameter to the metrics API commands (onlyParent or possibly a better name) to limit the metrics retrieved to the dataverse collection (either root, or the collection specified by parentAlias) when true. Default should be false for consistency with the current behaviour.

Any open or closed issues related to this feature request?

  • #6766

Are you thinking about creating a pull request for this feature?
Yes, but most likely in 2025

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Metrics API commands and reviewing related issue #6766. Trace how metrics are retrieved with and without parentAlias, then define the parameter's default and verify that enabled filtering excludes sub-collections while preserving current behavior when omitted.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
analytics, api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.