We’re delighted to see Roderic Page and Kris Shaffer putting the Hypothesis API to work. For us, the API isn’t just a great way to integrate Hypothesis with other systems. It’s also a way to try out ideas that inform the development of Hypothesis.
Today I’ll share two of those ideas. One is a faceted viewer that displays sets of annotations by user, group, and tag. The other exports annotations to several formats. If you’re a Hypothesis user, you may find these helpful until proper implementations are built into the product (faceted viewer: soon, export: later). And your feedback will help us design and build those features. If you’re a developer, you can use these as examples to learn to form API queries, authenticate for access to private and group annotations, parse JSON responses, and navigate threaded conversations.
Viewing annotation activity
Here’s a view of activity for Hypothesis user judell:
Results are organized like so:
- Annotations are grouped into threads.
- Threads are grouped by URL.
- URLs appear in reverse order by recency of annotation.
The URL for that view is:
By default only public annotations are shown. But if I capture my API token I can pop that into the form, or tack it on to the URL like so:
Now the page will show all my annotations, including those that are private (“Only Me”) and in groups I’ve joined. Just capture and swap in your own token to do this for yourself.
Variants of the page enable the same thing for tags, groups, or any facet.
Here’s a link for the tag hypothesis: http://jonudell.net/h/facet.html?facet=tag&tag=hypothesis.
Here’s a link for a group I just made, called Anyone Can Join:
If you join that group, then add your token to the form, you’ll get a view of group activity:
And here’s a link to search all facets for candelalearning:
The underlying API query in this case, https://hypothes.is/api/search?any=candelalearning, searches for the term candelalearning everywhere: in URLs, in tags, in annotation quotes and bodies. It can be a useful way to find all annotations for a domain, as happens in this case. But that’s only true when the term you’re searching for is uniquely associated with a domain (e.g. courses.candelalearning.com) and when the term does not include punctuation. A search for courses.candelalearning.com treats courses, candelalearning, and com as separate terms, and finds all kinds of stuff. So this isn’t a substitute for the forthcoming site: facet that will enable precise search for annotations within a domain.
A related single-page app, http://jonudell.net/h/export.html, enables you search along the same facets — user, group, and tag — and then export the results to HTML, CSV, text, and Markdown.
Here I’ve used it to search Jeremy Dean’s annotations for the tag nextprez:
I’ve omitted the token because that’s Jeremy’s secret, so only public annotations are shown here, but Jeremy could plug in his token to see all his stuff.
The HTML version of the export page is shown in the browser and also downloaded to hypothesis.html. Either way, it renders images and Markdown so you get a self-contained annotation set with full fidelity.
The CSV, text, and Markdown versions just report the number of annotations found. The exports land in your downloads folder as hypothesis.csv, hypothesis.txt, and hypothesis.md.
: The export feature is now merged with the activity viewer.
I’m working on some more experiments as well, including:
- Slack notification of group activity
- An LTI app that wraps annotation around Canvas files
- Controlled tagging for groups
- A button to copy individual annotations to the clipboard
If you’d like to participate in one of these experiments, annotate this post to let us know and we’ll be in touch.