dataverse icon indicating copy to clipboard operation
dataverse copied to clipboard

Feature Request/Idea: Add more informative message to MDC API when it is not set up

Open larsvilhuber opened this issue 1 year ago • 1 comments

Overview of the Feature Request

The MDC API responds to requests with a zero response even when the DV administrator has not set up MDC. It would be useful to provide a different response when that is the case, to avoid any confusion.

What kind of user is the feature intended for?

API User

What inspired the request?

My confusion in trying to get the API to spit out responses, and all example cases appear to have been cases that do not implement it.

What existing behavior do you want changed?

API request should provide a text answer that says something like

Make Data Count hasn't been set up, please try the Metrics API

Bonus: Add expected output both with and without MDC enabled to the Documentation.

Any brand new behavior do you want to add to Dataverse?

Nope.

Any open or closed issues related to this feature request?

Not sure.

Details

Current response is

{"status":"OK","data":{"message":"No metrics available for dataset 8939107 for null for country code null."}}

which can mean two things: Metrics have not been set up, and nobody has downloaded this dataset. I have no idea what the message would look like if it were for a server running MDC.

Proposed response would be

{"status":"FALSE","data":{"message":"Make Data Count hasn't been set up, please try the Metrics API ."}}

larsvilhuber avatar Mar 20 '24 19:03 larsvilhuber

@larsvilhuber makes sense, thanks!

For more context: https://groups.google.com/g/dataverse-community/c/MN1m9PWz8Ts/m/cOXQIdtJAQAJ

pdurbin avatar Mar 20 '24 20:03 pdurbin

I'm talking with someone who also tried using the API to get Make Data Count metrics. For folks with access, mostly at IQSS, see the email conversation at https://help.hmdc.harvard.edu/Ticket/Display.html?id=360573

jggautier avatar Apr 19 '24 14:04 jggautier

2025-07-07

  • Reviewed, keeping. Added preliminary size of 3.

cmbz avatar Jul 07 '25 14:07 cmbz