From 1f9ada3f471cbaf054b5c41dda2c638aa1975778 Mon Sep 17 00:00:00 2001 From: andrewxhill Date: Mon, 11 Apr 2016 16:47:29 -0400 Subject: [PATCH 1/4] double.. --- doc/api_docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api_docs.md b/doc/api_docs.md index 2937a66..e21d2f9 100644 --- a/doc/api_docs.md +++ b/doc/api_docs.md @@ -92,4 +92,4 @@ __todo__ ### Methodology -Segmentation is a method that divides a target market into subgroups based on shared common traits. While we plan to make many different segmentation methods available, our first release includes a segmentation profile first defined in a paper, _Understanding America's Neighborhoods Using Uncertain Data from the American Community Survey: Output Data: US_tract_clusters_new._. [See here](http://www.tandfonline.com/doi/pdf/10.1080/00045608.2015.1052335) for further information on the work in that paper. +Segmentation is a method that divides a target market into subgroups based on shared common traits. While we plan to make many different segmentation methods available, our first release includes a segmentation profile first defined in a paper, _Understanding America's Neighborhoods Using Uncertain Data from the American Community Survey: Output Data: US_tract_clusters_new_. [See here](http://www.tandfonline.com/doi/pdf/10.1080/00045608.2015.1052335) for further information on the work in that paper. From 2cb50eea9c3f36a357a9d987244fd3efa2fca7a1 Mon Sep 17 00:00:00 2001 From: andrewxhill Date: Mon, 11 Apr 2016 16:50:25 -0400 Subject: [PATCH 2/4] matched the api doc file naming to other repos --- doc/{api_docs.md => API.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{api_docs.md => API.md} (100%) diff --git a/doc/api_docs.md b/doc/API.md similarity index 100% rename from doc/api_docs.md rename to doc/API.md From 171309261ae3756424140be323c65ea8181aa77d Mon Sep 17 00:00:00 2001 From: andrewxhill Date: Mon, 11 Apr 2016 17:13:00 -0400 Subject: [PATCH 3/4] added field desc --- doc/API.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/API.md b/doc/API.md index e21d2f9..c8412c6 100644 --- a/doc/API.md +++ b/doc/API.md @@ -46,12 +46,14 @@ OBS_GetDemographicSnapshot(CDB_LatLng(40.810201, -73.956601)) ### Available fields +The Demographic Snapshot contains a broad subset of demographic measures in the Data Observatory. Over 80 measurements are returned by a single API request. + __todo__ -### OBS_GetSegmentationSnapshot +## OBS_GetSegmentationSnapshot -The Segmentation Snapshot API call 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 our geocoding documentation]. +The Segmentation Snapshot API call 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 our geocoding documentation]. ### API Syntax @@ -86,7 +88,7 @@ OBS_GetSegmentationSnapshot(CDB_LatLng(40.704512, -73.936669)) __todo__ -### Available fields +### Available segments __todo__ From 5f7fc83638d82589fa60027fdf9ba64966cf94f4 Mon Sep 17 00:00:00 2001 From: andrewxhill Date: Mon, 11 Apr 2016 17:16:34 -0400 Subject: [PATCH 4/4] added geo scope --- doc/API.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/API.md b/doc/API.md index c8412c6..6a2cd21 100644 --- a/doc/API.md +++ b/doc/API.md @@ -25,6 +25,12 @@ OBS_GetDemographicSnapshot({{point geometry}}) | account name | The name 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) | +#### Geographic Scope + +The Demographic Snapshot API is available for the following countries: + +* United States + ### API Examples __Get the Demographic Snapshot at Camp David__ @@ -69,6 +75,12 @@ OBS_GetSegmentationSnapshot({{point geometry}}) | account name | The name 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) | +#### Geographic Scope + +The Segmentation Snapshot API is available for the following countries: + +* United States + ### API Examples __Get the Segmentation Snapshot around the MGM Grand__ @@ -88,7 +100,7 @@ OBS_GetSegmentationSnapshot(CDB_LatLng(40.704512, -73.936669)) __todo__ -### Available segments +### Available segments __todo__