applied username for consitency, updated notes about availability-WIP
This commit is contained in:
@@ -2,29 +2,21 @@
|
||||
|
||||
The Demographic Snapshot API function enables you to collect demographic details around a point location. For example, you can take the coordinates of a bus stop and find the average population characteristics in that location. If you need help creating coordinates from addresses, see the [Geocoding Functions](/cartodb-platform/dataservices-api/geocoding-functions/) documentation.
|
||||
|
||||
_**Note:** The Demographic Snapshot API is currently only available for the United States._
|
||||
|
||||
## OBS_GetDemographicSnapshot( Point Geometry );
|
||||
|
||||
<<<<<<<<**PLEASE CONFIRM NAME, SPACING IN THE ACTUAL DATASERVICES API CODE APPEARS DIFFERENTLY FOR THIS FUNCTION?**>>>>>>>>
|
||||
|
||||
Fields returned include information about income, education, transportation, race, and more. Not all fields will have information for every coordinate queried.
|
||||
|
||||
##### Geographic Scope
|
||||
|
||||
The Demographic Snapshot API is available for the following countries:
|
||||
|
||||
* United States
|
||||
|
||||
<<<<<<<<**ARE THERE ANY MORE COUNTRIES SUPPORTED? OTHERWISE, I WILL MOVE THIS SECTION AS A NOTE INSTEAD**>>>>>>>>
|
||||
|
||||
### Arguments
|
||||
|
||||
Name | Description | Example Values
|
||||
--- | --- | ---
|
||||
account name | The name of your CartoDB account where the Data Observatory has been enabled | `example_account`
|
||||
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)`
|
||||
|
||||
<<<<<<<<**IS ACCOUNT NAME DIFFERENT THAN THE USERNAME FROM THEIR ACCOUNT SETTINGS?**>>>>>>>>
|
||||
|
||||
### 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.
|
||||
@@ -45,7 +37,7 @@ Name | Type | Description
|
||||
<<<<<<<<**THESE SHOULD BE WORKABLE EXAMPLES, WHY AREN'T WE USING {username}, LIKE OTHER API EXAMPLES?**>>>>>>>>
|
||||
|
||||
```html
|
||||
https://{{account name}}.cartodb.com/api/v2/sql?q=SELECT * FROM
|
||||
https://{{username}}.cartodb.com/api/v2/sql?q=SELECT * FROM
|
||||
OBS_GetDemographicSnapshot({{point geometry}})
|
||||
```
|
||||
|
||||
@@ -55,7 +47,7 @@ __Get the Demographic Snapshot at Camp David__
|
||||
|
||||
|
||||
```text
|
||||
https://example_account.cartodb.com/api/v2/sql?q=SELECT * FROM
|
||||
https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM
|
||||
OBS_GetDemographicSnapshot(CDB_LatLng(39.648333, -77.465))
|
||||
```
|
||||
|
||||
@@ -63,6 +55,6 @@ __Get the Demographic Snapshot in the Upper West Side__
|
||||
|
||||
|
||||
```text
|
||||
https://example_account.cartodb.com/api/v2/sql?q=SELECT * FROM
|
||||
https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM
|
||||
OBS_GetDemographicSnapshot(CDB_LatLng(40.80, -73.960))
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user