=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml' --- src/docbkx/en/dhis2_user_man_web_api.xml 2013-05-23 07:43:13 +0000 +++ src/docbkx/en/dhis2_user_man_web_api.xml 2013-05-23 17:10:40 +0000 @@ -1309,8 +1309,8 @@ - - + + Query parameter @@ -1345,6 +1345,24 @@ Filters for the data/measures EQ | GT | GE | LT | LE + + tableLayout + No + Use plain data source or table layout for response + false | true + + + columns + No + Dimensions to use as columns for table layout + Any dimension (must be query dimension) + + + rows + No + Dimensions to use as rows for table layout + Any dimension (must be query dimension) + The dimension query parameter defines which @@ -1381,6 +1399,15 @@ As an example, the following query will return only records where the data value is greater or equal to 6500 and less than 33000: api/analytics?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&dimension=pe:2012&dimension=ou:O6uvpzGd5pu;lc3eMKXaEfw&measureCriteria=GE:6500;LT:33000 + In order to have the analytics resource generate the data in the shape of a ready-made + table, you can provide the tableLayout parameter with + true as value. Instead of generating a plain, normalized data source, the analytics resource + will now generate the data in table layout. You can use the columns and rows parameters with dimension + identifiers separated by semi-colons as values to indicate which ones to use as table + columns and rows. The column and rows dimensions must be present as a data dimension in the + query (not a filter). Such a request can look like this: + api/analytics.html?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&dimension=pe:2012Q1;2012Q2&dimension=ou:O6uvpzGd5pu&tableLayout=true&columns=dx;ou&rows=pe
Response formats