dataservices-api/doc/segmentation_functions.md

2.1 KiB

Segmentation Functions

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 documentation.

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 contextual approach. Subsequent releases will include additional segmentation profiles.

OBS_GetSegmentationSnapshot( Point Geometry );

<<<<<<<<PLEASE CONFIRM NAME, SPACING IN THE ACTUAL DATASERVICES API CODE APPEARS DIFFERENTLY FOR THIS FUNCTION?>>>>>>>>

Arguments

Name Type Description Example Values
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)

Returns

todo

Name Type Description

todo

Examples

https://{{username}}.cartodb.com/api/v2/sql?q=SELECT * FROM
OBS_GetSegmentationSnapshot({{point geometry}})
Get the Geographic Snapshot of a Segmentation

Get the Segmentation Snapshot around the MGM Grand

https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM
OBS_GetSegmentationSnapshot(CDB_LatLng(36.10222, -115.169516))

Get the Segmentation Snapshot at CartoDB's NYC HQ

https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM
OBS_GetSegmentationSnapshot(CDB_LatLng(40.704512, -73.936669))