Added functionality to filter timeseries by dimensions

Author: LaurentGoderre

api/endpoints/timeseries/index.js

@@ -32,6 +32,10 @@ module.exports = {
 						options.indicator = req.query.indicator;
 					}
 
+					if (req.query.dimensions) {
+						options.dimensions = req.query.dimensions;
+					}
+
 					let {length, list} = await timeseries.list(start, count, urlResolver, options);
 					let links = paginationHelper.getLinks(pages, length, urlResolver);
 

api/endpoints/timeseries/model.js

@@ -1,5 +1,6 @@
 const {isValid} = require('./validation');
 const client = require('../../helpers/pg-client');
+const {parseDimensions} = require('../../helpers/parsers');
 const jsonapiHelper = require('../../helpers/jsonapi');
 const defaultUrlResolver = require('../../helpers/defaultUrlResolver');
 const observations = require('../observations/model');
@@ -24,6 +25,13 @@ function getFilters(options) {
 		filter.push(`indicator = '${options.indicator}'`);
 	}
 
+	if (options.dimensions) {
+		const dimensions = parseDimensions(options.dimensions);
+		for (const [key, values] of Object.entries(dimensions)) {
+			filter.push(`dimensions ->> '${key}' IN ('${values.join('\',\'')}')`);
+		}
+	}
+
 	return filter.length > 0 ? ` WHERE ${filter.join(' AND ')}` : '';
 }
 

docs/README.md

@@ -321,6 +321,13 @@ GET /observations/:observation_id
 GET /timeseries
 ```
 
+###### Parameteres ######
+
+| Name | Type | Description |
+|---|---|---|
+| indicator | string | The name of the indicator |
+| dimensions[:dimension_name] | string | Specify the dimension_name:value pair. Ex: `dimensions[geographicArea]=ON`. You can specify multiple value by repeating the parameter or via a comma-seperated value. Ex: `dimensions[geographicArea]=QC&dimensions[geographicArea]=ON` or `dimensions[geographicArea]=QC,ON` |
+
 ###### Response ######
 
 ```json