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

Update api-specification.md

parent 5a5ef3b1
No related branches found
No related tags found
No related merge requests found
...@@ -26,15 +26,22 @@ The aim is to provide information on the monthly download, plotting and inspecti ...@@ -26,15 +26,22 @@ The aim is to provide information on the monthly download, plotting and inspecti
Return download statistics based on the following query parameters: 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. **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. **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. **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. **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. **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. **downloadDateTo:** (optional) Include downloads on or before this date. Expects date in YYYY-MM-DD format.
### Examples from CLU: ### Examples from CLU:
```
curl -u user:pass 'https://cloudnet.fmi.fi/api/download/stats?dimensions=yearMonth,downloads&country=FI' 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: Returns monthly download statistics of data from all sites in Finland:
...@@ -64,9 +71,14 @@ If relevant; For each period, include campaign data if there are measurements fo ...@@ -64,9 +71,14 @@ If relevant; For each period, include campaign data if there are measurements fo
### GET /api/download/provision ### GET /api/download/provision
Return download statistics based on the following query parameters: Return download statistics based on the following query parameters:
*dimensions:* Comma-separated list of dimensions. Supported combinations are yearMonth variable, yearMonth facility and yearMonth instrument, yearMonth country **dimensions:** Comma-separated list of dimensions. Supported combinations are yearMonth variable, yearMonth facility and yearMonth instrument, yearMonth country
*facility:* (optional) Filter available datasets based on measurement facility. See https://head-office.fi/api/facility for available facilities.
*country:* (optional) Filter available datasets based on the country of measurement facilities. The country is specified using ISO 3166-1 alpha-2 code. **facility:** (optional) Filter available datasets based on measurement facility. See https://head-office.fi/api/facility for available facilities.
*productTypes:* (optional) Filter available datasets based on product type. Supported values are observation, model and fundamentalParameter.
*downloadDateFrom:* (optional) Include available datasets on or after this date. Expects date in YYYY-MM-DD format. **country:** (optional) Filter available datasets based on the country of measurement facilities. The country is specified using ISO 3166-1 alpha-2 code.
*downloadDateTo:* (optional) Include available datasets on or before this date. Expects date in YYYY-MM-DD format.
**productTypes:** (optional) Filter available datasets based on product type. Supported values are observation, model and fundamentalParameter.
**downloadDateFrom:** (optional) Include available datasets on or after this date. Expects date in YYYY-MM-DD format.
**downloadDateTo:** (optional) Include available datasets on or before this date. Expects date in YYYY-MM-DD format.
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