lsmyrnaios
/
pdf-aggregation-statistics
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Add documentation about the API in README.

This commit is contained in:
Lampros Smyrnaios 2023-06-20 22:49:44 +03:00
parent 83b8231993
commit df92e4fe24
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,6 +1,13 @@
# PDF Aggregation Statistics
This is a public API to get specific statistics from the PDF Aggregation Service.
<br>
**Statistics API**:
- "**getNumberOfPayloadsForDatasource**" endpoint: **http://\<IP\>:\<PORT\>/api/stats/getNumberOfPayloadsForDatasource?datasourceId=\<givenDatasourceId\>** <br>
This endpoint returns the number of payloads which belong to the datasource specified by the given datasourceID.
<br>
<br>
**To install and run the application**: