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

applied username for consitency, updated notes about availability-WIP

Browse Source
This commit is contained in:
csobier 2016-05-02 10:25:59 -04:00
parent b6cf319ed5
commit 2628a73a3f
2 changed files with 12 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/demographic_functions.md
View File

@ -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. 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 ); ## OBS_GetDemographicSnapshot( Point Geometry );
<<<<<<<<**PLEASE CONFIRM NAME, SPACING IN THE ACTUAL DATASERVICES API CODE APPEARS DIFFERENTLY FOR THIS FUNCTION?**>>>>>>>> <<<<<<<<**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. 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 ### Arguments
Name | Description | Example Values 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)` 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 ### 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.
@ -45,7 +37,7 @@ Name | Type | Description
<<<<<<<<**THESE SHOULD BE WORKABLE EXAMPLES, WHY AREN'T WE USING {username}, LIKE OTHER API EXAMPLES?**>>>>>>>> <<<<<<<<**THESE SHOULD BE WORKABLE EXAMPLES, WHY AREN'T WE USING {username}, LIKE OTHER API EXAMPLES?**>>>>>>>>
```html ```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}}) OBS_GetDemographicSnapshot({{point geometry}})
``` ```
@ -55,7 +47,7 @@ __Get the Demographic Snapshot at Camp David__
```text ```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)) OBS_GetDemographicSnapshot(CDB_LatLng(39.648333, -77.465))
``` ```
@ -63,6 +55,6 @@ __Get the Demographic Snapshot in the Upper West Side__
```text ```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)) OBS_GetDemographicSnapshot(CDB_LatLng(40.80, -73.960))
``` ```

24
doc/segmentation_functions.md
View File

@ -1,30 +1,20 @@
# Segmentation Functions # Segmentation Functions
The Segmentation Snapshot API function enables you to determine the pre-calculated population segment for a location. For example, you can take the location of a store location and determine what classification of population exists around that location. If you need help creating coordinates from addresses, see the [Geocoding Functions](/cartodb-platform/dataservices-api/geocoding-functions/) documentation. The Segmentation Snapshot API function enables you to determine the pre-calculated population segment for a location. Segmentation is a method that divides a target market into subgroups based on shared common traits. For example, you can take the location of a store location and determine what classification of population exists around that location. If you need help creating coordinates from addresses, see the [Geocoding Functions](/cartodb-platform/dataservices-api/geocoding-functions/) documentation.
_**Note:** Segmentation is a method that divides a target market into subgroups based on shared common traits. Currently, CartoDB includes the segmentation profile defined in the Output Data: US_tract_clusters_new_, as detailed in the _[Understanding America's Neighborhoods Using Uncertain Data from the American Community Survey](http://www.tandfonline.com/doi/pdf/10.1080/00045608.2015.1052335) contextual approach. Subsequent releases will include additional segmentation profiles._ _**Note:** The Segmentation Snapshot API is currently only available for the United States. CartoDB includes the segmentation profile defined in the Output Data: US_tract_clusters_new_, as detailed in the _[Understanding America's Neighborhoods Using Uncertain Data from the American Community Survey](http://www.tandfonline.com/doi/pdf/10.1080/00045608.2015.1052335) contextual approach. Subsequent releases will include additional segmentation profiles._
## OBS_GetSegmentationSnapshot( Point Geometry ); ## OBS_GetSegmentationSnapshot( Point Geometry );
<<<<<<<<**PLEASE CONFIRM NAME, SPACING IN THE ACTUAL DATASERVICES API CODE APPEARS DIFFERENTLY FOR THIS FUNCTION?**>>>>>>>> <<<<<<<<**PLEASE CONFIRM NAME, SPACING IN THE ACTUAL DATASERVICES API CODE APPEARS DIFFERENTLY FOR THIS FUNCTION?**>>>>>>>>
##### Geographic Scope
The Segmentation 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 ### Arguments
Name | Type | Description | Example Values Name | Type | 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 | `example_account`
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)` 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 ### Returns
__todo__ __todo__
@ -36,10 +26,8 @@ __todo__
### Examples ### Examples
<<<<<<<<**THESE SHOULD BE WORKABLE EXAMPLES, WHY AREN'T WE USING {username}, LIKE OTHER API EXAMPLES?**>>>>>>>>
```html ```html
https://{{account name}}.cartodb.com/api/v2/sql?q=SELECT * FROM https://{{username}}.cartodb.com/api/v2/sql?q=SELECT * FROM
OBS_GetSegmentationSnapshot({{point geometry}}) OBS_GetSegmentationSnapshot({{point geometry}})
``` ```
@ -49,7 +37,7 @@ __Get the Segmentation Snapshot around the MGM Grand__
```text ```text
https://example_account.cartodb.com/api/v2/sql?q=SELECT * FROM https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM
OBS_GetSegmentationSnapshot(CDB_LatLng(36.10222, -115.169516)) OBS_GetSegmentationSnapshot(CDB_LatLng(36.10222, -115.169516))
``` ```
@ -57,6 +45,6 @@ __Get the Segmentation Snapshot at CartoDB's NYC HQ__
```text ```text
https://example_account.cartodb.com/api/v2/sql?q=SELECT * FROM https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM
OBS_GetSegmentationSnapshot(CDB_LatLng(40.704512, -73.936669)) OBS_GetSegmentationSnapshot(CDB_LatLng(40.704512, -73.936669))
``` ```