IQSS / IQSS/dataverse

Feature Request: Public Metrics API - Number of Users per Affiliation / Collection

Open
#11,373 2 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
Add a new public metric that displays the current (and or historic?) amount of users associated with each Affiliation / Collection in a dataverse collection.

https://guides.dataverse.org/en/latest/api/metrics.html

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
API User, Developer, users who can benefit from this public metric

What inspired the request?
Users in our association that want a quick public count of users associated to an affiliation, developer who wants to use the metric for the purpose of an integration metrics app.

There is an api close to the desired behaviour: curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/users/:me"

But only displays the affiliation of the single user and is restricted to admin because of the additional sensitive data included in the json.

What existing behavior do you want changed?

Any brand new behavior do you want to add to Dataverse?
New API Metric

Any open or closed issues related to this feature request?

Are you thinking about creating a pull request for this feature?
Help is always welcome, is this feature something you or your organization plan to implement?
If given the green light

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 with the public metrics API guide and compare the requested metric with the existing /api/users/:me endpoint. Clarify whether counts are current or historic, how affiliation and collection relationships are defined, and what public response and access behavior should be considered done.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.