From 1039d1caa8672c1c5b73155d8d7b323974b8ff13 Mon Sep 17 00:00:00 2001 From: Stuart Lynn Date: Fri, 13 May 2016 14:49:47 -0400 Subject: [PATCH] Update demographic_functions.md Adding in example response and field details --- doc/demographic_functions.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/doc/demographic_functions.md b/doc/demographic_functions.md index 22e36a0..21a98ed 100644 --- a/doc/demographic_functions.md +++ b/doc/demographic_functions.md @@ -17,7 +17,26 @@ point geometry | A WKB point geometry. You can use the helper function, `CDB_Lat ### Returns -The Demographic Snapshot contains a broad subset of demographic measures in the Data Observatory. Over 80 measurements are returned by a single API request. * +The Demographic Snapshot contains a broad subset of demographic measures in the Data Observatory. Over 80 measurements are returned by a single API request. + +For each demographic measure the API will return + +Value | Name | Tablename | Aggregate | Type | Description +----- | ---- | --------- | --------- | ---- |------------ +The value of the measure at the point you requested | The name of the measure | The table it was drawn from | Indicated if the measure is a count or median. | The posgresql type | A description of the measure + +For example the "Female Population" measure returns + +```json +obs_getdemographicsnapshot: { + "value": 32.5395066379175, + "name": "Female Population", + "tablename": "obs_1a098da56badf5f32e336002b0a81708c40d29cd", + "aggregate": "sum", + "type": "Numeric", + "description": "The number of people within each geography who are female." +} +``` **For details, see [Glossary of Demographic Measures](#glossary-of-demographic-measures) below.**