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

Update api-specification.md

parent 3a370ce4
No related branches found
No related tags found
No related merge requests found
...@@ -29,9 +29,7 @@ returns monthly download statistics of data from all sites in Finland: ...@@ -29,9 +29,7 @@ returns monthly download statistics of data from all sites in Finland:
] ]
## ### GET /api/download/stats
GET /api/download/stats
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.
...@@ -56,12 +54,12 @@ If relevant; For each period, include campaign data if there are measurements fo ...@@ -56,12 +54,12 @@ If relevant; For each period, include campaign data if there are measurements fo
**Filter by: Variable, facility, instrument, country, productType, dateFrom, dateTo** **Filter by: Variable, facility, instrument, country, productType, dateFrom, dateTo**
### GET /api/download/stats ### 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
sitfacilitye: (optional) Filter downloads based on measurement facility. See https://head-office/api/facility for available facilities. *facility:* (optional) Filter available datasets based on measurement facility. See https://head-office/api/facility for available facilities.
country: (optional) Filter downloads based on the country of measurement facilities. The country is specified using ISO 3166-1 alpha-2 code. *country:* (optional) Filter available datasets based on the country of measurement facilities. 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) Filter available datasets based on product type. 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 available datasets 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 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