diff --git a/dspace_statistics_api/docs/index.html b/dspace_statistics_api/docs/index.html index 2b41931..681a0e1 100644 --- a/dspace_statistics_api/docs/index.html +++ b/dspace_statistics_api/docs/index.html @@ -9,9 +9,12 @@
This site is running the DSpace Statistics API. The following endpoints are available:
/
— return a basic API documentation page./items
— return views and downloads for all items that Solr knows about¹. Accepts limit
and page
query parameters for pagination of results./items
— return views and downloads for all items that Solr knows about¹. Accepts limit
and page
query parameters for pagination of results (limit
must be an integer between 1 and 100, and page
must be an integer greater than or equal to 0)./item/id
— return views and downloads for a single item (id
must be a positive integer). Returns HTTP 404 if an item id is not found.¹ The API is querying the Solr statistics core, which technically only knows about items that have either views or downloads.
+ +The item id is the internal id for an item. You can get these from the standard DSpace REST API.
+ +¹ We are querying the Solr statistics core, which technically only knows about items that have either views or downloads. If an item is not present here you can assume it has zero views and zero downloads, but not necessarily that it does not exist in the repository.