learningtapestry / metadataregistry

DEPRECATED - THIS CODE BASE IS NO LONGER MAINTAINED. Metadata Registry
Apache License 2.0
7 stars 5 forks source link

Statistics API #10

Open science opened 8 years ago

science commented 8 years ago

The LR community suggests a very useful feature to provide aggregate statistics about what is in the Learning Registry. This API might be some kind of REST-linked structure that provides "dig-able" statistics. Such as the following sequence of API calls:

API call: /api/v1/statistics
API result:
{ "lr-envelopes": {"count": 123456789}, 
  "@vocabs": [
    {"@vocab": "http://schema.org/", "api": "/api/v1/statistics?@vocab=http://schema.org/", "@count": 456789}
  ], 
  "@id": [
    {"@id": "lrmi:useRightsUrl", "api": "/api/v1/statistics?@id=lrmi:useRightsUrl", "@count": 3456}
  ]
}

From here, we could call /api/v1/statistics?@vocab=http://schema.org/ to dig into the stats underlying this vocabulary.

This is just a sketch of an idea for digging into aggregate statistics about what's inside LR, but the core idea is to give users the ability to see what is inside the system so they can find envelopes that are of interest, and that are present in sufficient quantity to make it worth parsing.