Documentation of output fields?

[dgorsline]

At https://catalog.archives.gov/interactivedocumentation, it would be helpful to see descriptions of the output fields (say, from a search) along with input fields. For instance, what are the units for queryTime?

Also, the link https://catalog.archives.gov/Document/ReferenceGuide.pdf seems to be broken.

[DominicBM]

Hi @dgorsline,

Thanks for the suggestion! To answer your question, queryTime's units are milliseconds (ms). But note this represents the search engine's time taken, and not necessarily the time it took to serve the response to you.

We'll take your idea your idea about better documenting the response fields into consideration. The interactive documentation in general could use some upgrading. It began as more of an experiment, and it is useful to know if users are utilizing it and wanting better functionality.

The broken link is a known issue, not yet fixed. For what it's worth, that section was written before we had documentation on GitHub, which is where that should point users anyway, so you already have access to it.