Skip to content

Commit d4b2fcb

Browse files
Update readme
1 parent 7435ffd commit d4b2fcb

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

readme.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ This is part of the DataCite Usage Analytics service.
77
This has a public API that is the main endpoint for the [DataCite Tracker](https://github.com/datacite/datacite-tracker)
88
Events are stored within a Clickhouse database and then statistics according to COUNTER can be calculated.
99

10+
### Setup
11+
12+
1. Install the tracking script [DataCite Tracker](https://github.com/datacite/datacite-tracker)
13+
2. Configure using appropriate details
14+
3. Results should be sent to the /api/metric end point
15+
4. You can use the check api endpoint /api/check/{repo_id} to see if results are being recorded, it returns 200 and the timestamp of the last event if successful.
16+
1017
## COUNTER Usage Report Generation
1118

1219
Based on the data stored in Clickhouse and statistics that can be generated, usage reports in the format of SUSHI Json can be generated.

0 commit comments

Comments
 (0)