cartodb4/dataservices-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update demographic_functions.md

Browse Source 
Adding in example response and field details
This commit is contained in:
Stuart Lynn
2016-05-13 14:49:47 -04:00
parent d745ba2ae7
commit 1039d1caa8
1 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/demographic_functions.md
View File

@@ -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.**