moved order of some examples for output

This commit is contained in:
csobier
2016-05-16 08:48:51 -04:00
parent f9c0b73737
commit 5376af3d2b
2 changed files with 9 additions and 12 deletions

View File

@@ -41,7 +41,7 @@ obs_getdemographicsnapshot: {
### Examples
```bash
https://{{username}}.cartodb.com/api/v2/sql?q=SELECT * FROM
https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM
OBS_GetDemographicSnapshot({{point geometry}})
```

View File

@@ -8,19 +8,21 @@ _**Note:** The Segmentation Snapshot functions are only available for the United
### Arguments
Name | Type | Description | Example Values
--- | --- | --- | ---
Name | Description | Example Values
--- | --- | ---
username | The username of your CartoDB account where the Data Observatory has been enabled | `username`
point geometry | A WKB point geometry. You can use the helper function, `CDB_LatLng` to quickly generate one from latitude and longitude | `CDB_LatLng(40.760410,-73.964242)`
### Returns
The segmentation function returns two segment levels for the point you requests, the x10\_segment and x55\_segment. These segmentation levels contain different classifications of population within with each segment:
The segmentation function returns two segment levels for the point you requests, the x10\_segment and x55\_segment. These segmentation levels contain different classifications of population within with each segment. The function also returns the quantile of a number of census variables. For example, if total_poulation is at 90% quantile level then this tract has a higher total population than 90% of the other tracts.
- x10\_segments contain populations at high-levels, broken down into 10 broad categories
- x55\_segments contain more granular sub-levels to categorize the population
Name | Type | Description
---- | ---- | -----------
x10\_segment | text | The demographic segment location at the 10 segment level, containing populations at high-levels, broken down into 10 broad categories
x55\_segment | text | The demographic segment location at the 55 segment level, containing more granular sub-levels to categorize the population
The function also returns the quantile of a number of census variables. For example, if total_poulation is at 90% quantile level then this tract has a higher total population than 90% of the other tracts. An example response appears as follows:
An example response appears as follows:
```json
obs_getsegmentsnapshot: {
@@ -73,11 +75,6 @@ obs_getsegmentsnapshot: {
}
```
Name | Type | Description
---- | ---- | -----------
x10\_segment | text | The demographic segment this location belongs at the 10 segment level
x55\_segment | text | The demographic segment this location belongs at the 55 segment level
The possible segments are:
<table>