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

Update api-specification.md

parent 180cbc61
No related branches found
No related tags found
No related merge requests found
......@@ -20,17 +20,17 @@ The aim is to provide information on the monthly download, plotting and inspecti
* Monthly unique IPs
* Download by country
**Filter by: Facility, country, productType, dateFrom, dateTo**
**Filter by:** Facility, country, productType, dateFrom, dateTo
### GET /api/download/stats
Return download statistics based on the following query parameters:
*dimensions:* Comma-separated list of dimensions. Supported combinations are yearMonth,downloads, yearMonth,uniqueIps and country,downloads.
*facility:* (optional) Filter downloads based on measurement facility. See https://head-office.fi/api/facilities for available facilities.
*country:* (optional) Filter downloads based on the country of measurement facility. The country is specified using ISO 3166-1 alpha-2 code.
*productTypes:* (optional) Comma-separated list of product types. Supported values are observation, model and fundamentalParameter.
*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.
**dimensions:** Comma-separated list of dimensions. Supported combinations are yearMonth,downloads, yearMonth,uniqueIps and country,downloads.
**facility:** (optional) Filter downloads based on measurement facility. See https://head-office.fi/api/facilities for available facilities.
**country:** (optional) Filter downloads based on the country of measurement facility. The country is specified using ISO 3166-1 alpha-2 code.
**productTypes:** (optional) Comma-separated list of product types. Supported values are observation, model and fundamentalParameter.
**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.
### Examples from CLU:
......@@ -38,11 +38,13 @@ curl -u user:pass 'https://cloudnet.fmi.fi/api/download/stats?dimensions=yearMon
Returns monthly download statistics of data from all sites in Finland:
'''
[
{ "yearMonth": "2021-02", "downloads": 0.08487337440109514 },
...
{ "yearMonth": "2022-11", "downloads": 26.00684462696783 }
]
'''
## ACTRIS Data provision
......
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