Skip to content
Snippets Groups Projects
Commit 2154da0b authored by Richard Olav Rud's avatar Richard Olav Rud
Browse files

Update api-specification.md

parent 76ea62be
No related branches found
No related tags found
No related merge requests found
API specification for monitoring of data provision and data access
# API specification for monitoring of data provision and data access
# Introduction
We would like for all ACTRIS DC units to provide their statistics through an API. DVAS will fetch the metrics and dislpay the information in the DVAS portal. The information is to be used for reporting to Head Office.
## Introduction
We would like for all ACTRIS DC units to provide their data provision and access statistics through an API. DVAS will fetch the metrics and dislpay the information in the DVAS portal. The information is to be used for reporting to Head Office and ACTRIS DC Management Board.
# Monitoring of access to ACTRIS data
## Monitoring of access to ACTRIS data
## Metrics
The aim is to provide information on the monthly download, plotting and inspection of data in the ACTRIS data centre. How is the geographical distribution of users. And where are data used most intensively.
*Definitions*
One unique user: 1 unique = 1 IP address.
Users: the sum of all unique users of data, but exclude the access resulting the use and access by data centre staff (people working internally at CNR, CNRS, FMI, NILU on the DB e.g. developers and maintenance).
### Metrics
* Monthly downloads
* Monthly unique IPs
......@@ -17,7 +23,7 @@ Results:
Month, downloads in variable years
## Examples from CLU:
### Examples from CLU:
curl -u user:pass 'https://cloudnet.fmi.fi/api/download/stats?dimensions=yearMonth,downloads&country=FI'
returns monthly download statistics of data from all sites in Finland:
......@@ -39,7 +45,7 @@ productTypes (optional) Comma-separated list of product types. Supported values
downloadDateFrom (optional) Include downloads on or after this date. Expects date in YYYY-MM-DD format.
downloadDateTo (optional) Include downloads on or before this date. Expects date in YYYY-MM-DD format.
# ACTRIS Data provision
## ACTRIS Data provision
The aim is to provide information on the data provided to ACTRIS in the previous years. How many sites are contributing aiming for continues long-term measurement? How is this developing over time? How many sites and datasets are included in the NRT data provision?
......@@ -47,7 +53,7 @@ For each variable in the Data Management Plan, give the number of sites with ann
If relevant; For each period, include campaign data if there are measurements for more than 1 Month.
## Metrics
### Metrics
* Number of facilities with QA annual data sets
* Number of facilities with QA campaign data sets
* Number of facilities with NRT data sets
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment