dspace-statistics-api/dspace_statistics_api/docs/index.html

<!DOCTYPE html>
<html lang="en-US">
    <head>
        <meta charset="UTF-8">
        <title>DSpace Statistics API</title>
    </head>
    <body>
        <h1>DSpace Statistics API</h1>
        <p>This site is running the <a href="https://github.com/ilri/dspace-statistics-api" title="DSpace Statistics API project">DSpace Statistics API</a>. The following endpoints are available:</p>
        <ul>
            <li>GET <code>/</code> — return a basic API documentation page.</li>
            <li>GET <code>/items</code> — return views and downloads for all items that Solr knows about¹. Accepts <code>limit</code> and <code>page</code> query parameters for pagination of results (<code>limit</code> must be an integer between 1 and 100, and <code>page</code> must be an integer greater than or equal to 0).</li>
            <li>POST <code>/items</code> — return views and downloads for an arbitrary list of items. Accepts <code>limit</code>, <code>page</code>, <code>dateFrom</code>, and <code>dateTo</code> parameters².</li>
            <li>GET <code>/item/id</code> — return views and downloads for a single item (<code>id</code> must be a UUID). Returns HTTP 404 if an item id is not found.</li>
        </ul>

        <p>The item id is the <em>internal</em> uuid for an item. You can get these from the standard DSpace REST API.</p>

        <hr/>

        <p>¹ 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.</p>
        <p>² POST requests to <code>/items</code> should be in JSON format with the following parameters:
			<pre><code>{
	"limit": 100, // optional, integer between 0 and 100, default 100
	"page": 0, // optional, integer greater than 0, default 0
	"dateFrom": "2020-01-01T00:00:00Z", // optional, default *
	"dateTo": "2020-09-09T00:00:00Z", // optional, default *
	"items": [
		"f44cf173-2344-4eb2-8f00-ee55df32c76f",
		"2324aa41-e9de-4a2b-bc36-16241464683e",
		"8542f9da-9ce1-4614-abf4-f2e3fdb4b305",
		"0fe573e7-042a-4240-a4d9-753b61233908"
	]
}</code></pre>
        </p>
    </body>
</html>
-												Add basic API documentation on root (/)

I had imagined plugging in an interactive Swagger or OpenAPI instance
here, but that's actually much more involved in Falcon than I want to
deal with right now.

											
										
										
											2018-10-31 23:19:39 +01:00
+								<!DOCTYPE html>
 								<html lang="en-US">
 								    <head>
 								        <meta charset="UTF-8">
 								        <title>DSpace Statistics API</title>
 								    </head>
 								    <body>
 								        <h1>DSpace Statistics API</h1>
 								        <p>This site is running the <a href="https://github.com/ilri/dspace-statistics-api" title="DSpace Statistics API project">DSpace Statistics API</a>. The following endpoints are available:</p>
 								        <ul>
 								            <li>GET <code>/</code> — return a basic API documentation page.</li>
-												Sync API documentation HTML with README.md

											
										
										
											2018-10-31 23:37:52 +01:00
+								            <li>GET <code>/items</code> — return views and downloads for all items that Solr knows about¹. Accepts <code>limit</code> and <code>page</code> query parameters for pagination of results (<code>limit</code> must be an integer between 1 and 100, and <code>page</code> must be an integer greater than or equal to 0).</li>
-												Update API docs HTML for /items POST functionality

											
										
										
											2020-09-25 11:53:30 +02:00
+								            <li>POST <code>/items</code> — return views and downloads for an arbitrary list of items. Accepts <code>limit</code>, <code>page</code>, <code>dateFrom</code>, and <code>dateTo</code> parameters².</li>
-												dspace_statistics_api/docs/index.html: Adjust help text

											
										
										
											2020-03-02 13:30:16 +01:00
+								            <li>GET <code>/item/id</code> — return views and downloads for a single item (<code>id</code> must be a UUID). Returns HTTP 404 if an item id is not found.</li>
-												Add basic API documentation on root (/)

I had imagined plugging in an interactive Swagger or OpenAPI instance
here, but that's actually much more involved in Falcon than I want to
deal with right now.

											
										
										
											2018-10-31 23:19:39 +01:00
+								        </ul>
-												Sync API documentation HTML with README.md

											
										
										
											2018-10-31 23:37:52 +01:00
-												dspace_statistics_api/docs/index.html: Adjust help text

											
										
										
											2020-03-02 13:30:16 +01:00
+								        <p>The item id is the <em>internal</em> uuid for an item. You can get these from the standard DSpace REST API.</p>
-												Sync API documentation HTML with README.md

											
										
										
											2018-10-31 23:37:52 +01:00
-												Update API docs HTML for /items POST functionality

											
										
										
											2020-09-25 11:53:30 +02:00
+								        <hr/>
-												dspace_statistics_api/docs/index.html: Minor HTML syntax issue

											
										
										
											2020-09-25 11:55:39 +02:00
+								        <p>¹ 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.</p>
-												Update API docs HTML for /items POST functionality

											
										
										
											2020-09-25 11:53:30 +02:00
+								        <p>² POST requests to <code>/items</code> should be in JSON format with the following parameters:
-												dspace_statistics_api/docs/index.html: Fix whitespace

											
										
										
											2020-09-25 12:33:45 +02:00
+											<pre><code>{
-												Update API docs HTML for /items POST functionality

											
										
										
											2020-09-25 11:53:30 +02:00
+									"limit": 100, // optional, integer between 0 and 100, default 100
 									"page": 0, // optional, integer greater than 0, default 0
 									"dateFrom": "2020-01-01T00:00:00Z", // optional, default *
 									"dateTo": "2020-09-09T00:00:00Z", // optional, default *
 									"items": [
 										"f44cf173-2344-4eb2-8f00-ee55df32c76f",
 										"2324aa41-e9de-4a2b-bc36-16241464683e",
 										"8542f9da-9ce1-4614-abf4-f2e3fdb4b305",
 										"0fe573e7-042a-4240-a4d9-753b61233908"
 									]
-												dspace_statistics_api/docs/index.html: Fix whitespace

											
										
										
											2020-09-25 12:33:45 +02:00
+								}</code></pre>
-												dspace_statistics_api/docs/index.html: Minor HTML syntax issue

											
										
										
											2020-09-25 11:55:39 +02:00
+								        </p>
-												Add basic API documentation on root (/)

I had imagined plugging in an interactive Swagger or OpenAPI instance
here, but that's actually much more involved in Falcon than I want to
deal with right now.

											
										
										
											2018-10-31 23:19:39 +01:00
+								    </body>
 								</html>