Data Observatory v1

Introduction

The Data Observatory, available for Enterprise accounts, provides access to a catalog of analyzed data methods, and enables you to apply the results to your own datasets.

The contents described in this document are subject to CARTO’s Terms of Service

Authentication

Data Observatory, like any other CARTO platform’s component, requires using an API Key. From your CARTO dashboard, click Your API keys from the avatar drop-down menu to view your uniquely generated API Key for managing data with CARTO Engine.

Learn more about the basics of authorization, or dig into the details of Auth API, if you want to know more about this part of CARTO platform.

The examples in this documentation may include a placeholder for the API Key. Ensure that you modify any placeholder parameters with your own credentials.

Versioning

Data Observartory uses Semantic Versioning. View our Github repository to find tags for each release.

Measures Functions

Data Observatory Measures are the numerical location data you can access. The measure functions allow you to access individual measures to augment your own data or integrate in your analysis workflows. Measures are used by sending an identifier or a geometry (point or polygon) and receiving back a measure (an absolute value) for that location.

There are hundreds of measures and the list is growing with each release. You can currently discover and learn about measures contained in the Data Observatory by downloading our Data Catalog.

You can access measures through CARTO Builder. The same methods will work if you are using the CARTO Engine to develop your application. We encourage you to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT).

OBS_GetUSCensusMeasure(point geometry, measure_name text)

The OBS_GetUSCensusMeasure(point, measure_name) function returns a measure based on a subset of the US Census variables at a point location. The OBS_GetUSCensusMeasure function is limited to only a subset of all measures that are available in the Data Observatory. To access the full list, use measure IDs with the OBS_GetMeasure function below.

Arguments

Returns

A NUMERIC value

Example

Add a measure to an empty numeric column based on point locations in your table.

1
2
UPDATE tablename
SET total_population = OBS_GetUSCensusMeasure(the_geom, 'Total Population')

OBS_GetUSCensusMeasure(polygon geometry, measure_name text)

The OBS_GetUSCensusMeasure(polygon, measure_name) function returns a measure based on a subset of the US Census variables within a given polygon. The OBS_GetUSCensusMeasure function is limited to only a subset of all measures that are available in the Data Observatory. To access the full list, use the OBS_GetMeasure function below.

Arguments

Returns

A NUMERIC value

Example

Add a measure to an empty numeric column based on polygons in your table

1
2
UPDATE tablename
SET local_male_population = OBS_GetUSCensusMeasure(the_geom, 'Male Population')

OBS_GetMeasure(point geometry, measure_id text)

The OBS_GetMeasure(point, measure_id) function returns any Data Observatory measure at a point location. You can browse all available Measures in the Catalog.

Arguments

Returns

A NUMERIC value

Example

Add a measure to an empty numeric column based on point locations in your table

1
2
UPDATE tablename
SET median_home_value_sqft = OBS_GetMeasure(the_geom, 'us.zillow.AllHomes_MedianValuePerSqft')

OBS_GetMeasure(polygon geometry, measure_id text)

The OBS_GetMeasure(polygon, measure_id) function returns any Data Observatory measure calculated within a polygon.

Arguments

Returns

A NUMERIC value

Example

Add a measure to an empty column based on polygons in your table

1
2
UPDATE tablename
SET household_count = OBS_GetMeasure(the_geom, 'us.census.acs.B11001001')

Errors

• If an unrecognized normalization type is input, raises error: 'Only valid inputs for "normalize" are "area" (default) and "denominator".

OBS_GetMeasureById(geom_ref text, measure_id text, boundary_id text)

The OBS_GetMeasureById(geom_ref, measure_id, boundary_id) function returns any Data Observatory measure that corresponds to the boundary in boundary_id that has a geometry reference of geom_ref.

Arguments

Returns

A NUMERIC value

Example

Add a measure to an empty column based on county geoids in your table

1
2
UPDATE tablename
SET household_count = OBS_GetMeasureById(geoid_column, 'us.census.acs.B11001001', 'us.census.tiger.county')

Errors

• Returns NULL if there is a mismatch between the geometry reference and the boundary id such as using the geoid of a county with the boundary of block groups

OBS_GetCategory(point geometry, category_id text)

The OBS_GetCategory(point, category_id) function returns any Data Observatory Category value at a point location. The Categories available are currently limited to Segmentation categories. See the Segmentation section of the Catalog for more detail.

Arguments

Returns

A TEXT value

Example

Add the Category to an empty column text column based on point locations in your table

1
2
UPDATE tablename
SET segmentation = OBS_GetCategory(the_geom, 'us.census.spielman_singleton_segments.X55')

OBS_GetMeta(extent geometry, metadata json, max_timespan_rank, max_score_rank, target_geoms)

The OBS_GetMeta(extent, metadata) function returns a completed Data Observatory metadata JSON Object for use in OBS_GetData(geomvals, metadata) or OBS_GetData(ids, metadata). It is not possible to pass metadata to those functions if it is not processed by OBS_GetMeta(extent, metadata) first.

OBS_GetMeta makes it possible to automatically select appropriate timespans and boundaries for the measurement you want.

Arguments

The schema of the metadata input objects are as follows:

Returns

A JSON array composed of metadata output objects.

The schema of the metadata output objects are as follows. You should pass this array as-is to OBS_GetData. If you modify any values the function will fail.

Examples

Obtain metadata that can augment with one additional column of US population data, using a boundary relevant for the geometry provided and latest timespan. Limit to only the most recent column most relevant to the extent & density of input geometries in tablename.

1
2
3
4
5
6
SELECT OBS_GetMeta(
  ST_SetSRID(ST_Extent(the_geom), 4326),
  '[{"numer_id": "us.census.acs.B01003001"}]',
  1, 1,
  COUNT(*)
) FROM tablename

Obtain metadata that can augment with one additional column of US population data, using census tract boundaries.

1
2
3
4
5
6
SELECT OBS_GetMeta(
  ST_SetSRID(ST_Extent(the_geom), 4326),
  '[{"numer_id": "us.census.acs.B01003001", "geom_id": "us.census.tiger.census_tract"}]',
  1, 1,
  COUNT(*)
) FROM tablename

Obtain metadata that can augment with two additional columns, one for total population and one for male population.

1
2
3
4
5
6
SELECT OBS_GetMeta(
  ST_SetSRID(ST_Extent(the_geom), 4326),
  '[{"numer_id": "us.census.acs.B01003001"}, {"numer_id": "us.census.acs.B01001002"}]',
  1, 1,
  COUNT(*)
) FROM tablename

OBS_MetadataValidation(extent geometry, geometry_type text, metadata json, target_geoms)

The OBS_MetadataValidation function performs a validation check over the known issues using the extent, type of geometry, and metadata that is being used in the OBS_GetMeta function.

Arguments

The schema of the metadata input objects are as follows:

Returns

Examples

Validate metadata with two additional columns of US census data; using a boundary relevant for the geometry provided and the latest timespan. Limited to the most recent column, and the most relevant, based on the extent and density of input geometries in tablename.

1
2
3
4
5
6
7
SELECT OBS_MetadataValidation(
  ST_SetSRID(ST_Extent(the_geom), 4326),
  ST_GeometryType(the_geom),
  '[{"numer_id": "us.census.acs.B01003001"}, {"numer_id": "us.census.acs.B01001002"}]',
  COUNT(*)::INTEGER
) FROM tablename
GROUP BY ST_GeometryType(the_geom)

OBS_GetData(geomvals array[geomval], metadata json)

The OBS_GetData(geomvals, metadata) function returns a measure and/or geometry corresponding to the metadata JSON array for each every Geometry of the geomval element in the geomvals array. The metadata argument must be obtained from OBS_GetMeta(extent, metadata).

Arguments

Returns

A TABLE with the following schema, where each element of the input geomvals array corresponds to one row:

Each data object has the following keys:

To determine the appropriate cast for value, one can use the numer_type or geom_type key corresponding to that value in the input metadata JSON array.

Examples

Obtain population densities for every geometry in a table, keyed by cartodb_id:

1
2
3
4
5
6
7
8
9
WITH meta AS (
  SELECT OBS_GetMeta(
    ST_SetSRID(ST_Extent(the_geom), 4326),
    '[{"numer_id": "us.census.acs.B01003001"}]',
    1, 1, COUNT(*)
) meta FROM tablename)
SELECT id AS cartodb_id, (data->0->>'value')::Numeric AS pop_density
FROM OBS_GetData((SELECT ARRAY_AGG((the_geom, cartodb_id)::geomval) FROM tablename),
                 (SELECT meta FROM meta))

Update a table with a blank numeric column called pop_density with population densities:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
WITH meta AS (
  SELECT OBS_GetMeta(
    ST_SetSRID(ST_Extent(the_geom), 4326),
    '[{"numer_id": "us.census.acs.B01003001"}]',
    1, 1, COUNT(*)
) meta FROM tablename),
data AS (
  SELECT id AS cartodb_id, (data->0->>'value')::Numeric AS pop_density
  FROM OBS_GetData((SELECT ARRAY_AGG((the_geom, cartodb_id)::geomval) FROM tablename),
                   (SELECT meta FROM meta)))
UPDATE tablename
SET pop_density = data.pop_density
FROM data
WHERE cartodb_id = data.id

Update a table with two measurements at once, population density and household density. The table should already have a Numeric column pop_density and household_density.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
WITH meta AS (
  SELECT OBS_GetMeta(
    ST_SetSRID(ST_Extent(the_geom),4326),
    '[{"numer_id": "us.census.acs.B01003001"},{"numer_id": "us.census.acs.B11001001"}]',
    1, 1, COUNT(*)
) meta from tablename),
data AS (
  SELECT id,
     data->0->>'value' AS pop_density,
     data->1->>'value' AS household_density
  FROM OBS_GetData((SELECT ARRAY_AGG((the_geom, cartodb_id)::geomval) FROM tablename),
                   (SELECT meta FROM meta)))
UPDATE tablename
SET pop_density = data.pop_density,
    household_density = data.household_density
FROM data
WHERE cartodb_id = data.id

OBS_GetData(ids array[text], metadata json)

The OBS_GetData(ids, metadata) function returns a measure and/or geometry corresponding to the metadata JSON array for each every id of the ids array. The metadata argument must be obtained from OBS_GetMeta(extent, metadata). When obtaining metadata, one must include the geom_id corresponding to the boundary that the ids refer to.

Arguments

For this function to work, the metadata argument must include a geom_id that corresponds to the ids found in col_of_geom_refs.

Returns

A TABLE with the following schema, where each element of the input ids array corresponds to one row:

Each data object has the following keys:

To determine the appropriate cast for value, one can use the numer_type or geom_type key corresponding to that value in the input metadata JSON array.

Examples

Obtain population densities for every row of a table with FIPS code county IDs (USA).

1
2
3
4
5
6
7
8
WITH meta AS (
  SELECT OBS_GetMeta(
    ST_SetSRID(ST_Extent(the_geom), 4326),
    '[{"numer_id": "us.census.acs.B01003001", "geom_id": "us.census.tiger.county"}]'
) meta FROM tablename)
SELECT id AS fips, (data->0->>'value')::Numeric AS pop_density
FROM OBS_GetData((SELECT ARRAY_AGG(fips) FROM tablename),
                 (SELECT meta FROM meta))

Update a table with population densities for every FIPS code county ID (USA). This table has a blank column called pop_density and fips codes stored in a column fips.

1
2
3
4
5
6
7
8
9
10
11
12
13
WITH meta AS (
  SELECT OBS_GetMeta(
    ST_SetSRID(ST_Extent(the_geom), 4326),
    '[{"numer_id": "us.census.acs.B01003001", "geom_id": "us.census.tiger.county"}]'
) meta FROM tablename),
data as (
  SELECT id AS fips, (data->0->>'value') AS pop_density
  FROM OBS_GetData((SELECT ARRAY_AGG(fips) FROM tablename),
                   (SELECT meta FROM meta)))
UPDATE tablename
SET pop_density = data.pop_density
FROM data
WHERE fips = data.id

Boundary Functions

Use the following functions to retrieve Boundary data. Data ranges from small areas (e.g. US Census Block Groups) to large areas (e.g. Countries). You can access boundaries by point location lookup, bounding box lookup, direct ID access and several other methods described below.

You can access boundaries through CARTO Builder. The same methods will work if you are using the CARTO Engine to develop your application. We encourage you to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT).

OBS_GetBoundariesByGeometry(geom geometry, geometry_id text)

The OBS_GetBoundariesByGeometry(geometry, geometry_id) method returns a set of boundary geometries that intersect a supplied geometry. This can be used to find all boundaries that are within or overlap a bounding box. You have the ability to choose whether to retrieve all boundaries that intersect your supplied bounding box or only those that fall entirely inside of your bounding box.

Arguments

Returns

A table with the following columns:

If geometries are not found for the requested geom, geometry_id, timespan, or overlap_type, then null values are returned.

Example

Insert all Census Tracts from Lower Manhattan and nearby areas within the supplied bounding box to a table named manhattan_census_tracts which has columns the_geom (geometry) and geom_refs (text).

1
2
3
4
5
6
7
INSERT INTO manhattan_census_tracts(the_geom, geom_refs)
SELECT *
FROM OBS_GetBoundariesByGeometry(
       ST_MakeEnvelope(-74.0251922607,40.6945658517,
                      -73.9651107788,40.7377626342,
                      4326),
       'us.census.tiger.census_tract')

Errors

• If an overlap_type other than the valid ones listed above is entered, then an error is thrown

OBS_GetPointsByGeometry(polygon geometry, geometry_id text)

The OBS_GetPointsByGeometry(polygon, geometry_id) method returns point geometries and their geographical identifiers that intersect (or are contained by) a bounding box polygon and lie on the surface of a boundary corresponding to the boundary with same geographical identifiers (e.g., a point that is on a census tract with the same geoid). This is a useful alternative to OBS_GetBoundariesByGeometry listed above because it returns much less data for each location.

Arguments

Returns

A table with the following columns:

If geometries are not found for the requested geometry, geometry_id, timespan, or overlap_type, then NULL values are returned.

Example

Insert points that lie on Census Tracts from Lower Manhattan and nearby areas within the supplied bounding box to a table named manhattan_tract_points which has columns the_geom (geometry) and geom_refs (text).

1
2
3
4
5
6
7
INSERT INTO manhattan_tract_points (the_geom, geom_refs)
SELECT *
FROM OBS_GetPointsByGeometry(
       ST_MakeEnvelope(-74.0251922607,40.6945658517,
                       -73.9651107788,40.7377626342,
                       4326),
       'us.census.tiger.census_tract')

Errors

• If a geometry other than a point is passed as the first argument, an error is thrown: Invalid geometry type (ST_Point), expecting 'ST_MultiPolygon' or 'ST_Polygon'

OBS_GetBoundary(point_geometry, boundary_id)

The OBS_GetBoundary(point_geometry, boundary_id) method returns a boundary geometry defined as overlapping the point geometry and from the desired boundary set (e.g. Census Tracts). See the Boundary ID Glossary. This is a useful method for performing aggregations of points.

Arguments

Returns

A boundary geometry. If no value is found at the requested boundary_id or timespan, a null value is returned.

Example

Overwrite a point geometry with a boundary geometry that contains it in your table

1
2
UPDATE tablename
SET the_geom = OBS_GetBoundary(the_geom, 'us.census.tiger.block_group')

Errors

• If a geometry other than a point is passed, an error is thrown: Invalid geometry type (ST_Line), expecting 'ST_Point'

OBS_GetBoundaryId(point_geometry, boundary_id)

The OBS_GetBoundaryId(point_geometry, boundary_id) returns a unique geometry_id for the boundary geometry that contains a given point geometry. See the Boundary ID Glossary. The method can be combined with OBS_GetBoundaryById(geometry_id) to create a point aggregation workflow.

Arguments

Returns

A TEXT boundary geometry id. If no value is found at the requested boundary_id or timespan, a null value is returned.

Example

Write the US Census block group geoid that contains the point geometry for every row as a new column in your table.

1
2
UPDATE tablename
SET geometry_id = OBS_GetBoundaryId(the_geom, 'us.census.tiger.block_group')

Errors

• If a geometry other than a point is passed, an error is thrown: Invalid geometry type (ST_Line), expecting 'ST_Point'

OBS_GetBoundaryById(geometry_id, boundary_id)

The OBS_GetBoundaryById(geometry_id, boundary_id) returns the boundary geometry for a unique geometry_id. A geometry_id can be found using the OBS_GetBoundaryId(point_geometry, boundary_id) method described above.

Arguments

Returns

A boundary geometry. If a geometry is not found for the requested geometry_id, boundary_id, or timespan, then a null value is returned.

Example

Use a table of geometry_ids (e.g., geoid from the U.S. Census) to select the unique boundaries that they correspond to and insert into a table called, overlapping_polygons. This is a useful method for creating new choropleths of aggregate data.

1
2
3
4
5
6
7
INSERT INTO overlapping_polygons (the_geom, geometry_id, point_count)
SELECT
  OBS_GetBoundaryById(geometry_id, 'us.census.tiger.county') As the_geom,
  geometry_id,
  count(*)
FROM tablename
GROUP BY geometry_id

OBS_GetBoundariesByPointAndRadius(point geometry, radius numeric, boundary_id text)

The OBS_GetBoundariesByPointAndRadius(point, radius, boundary_id) method returns boundary geometries and their geographical identifiers that intersect (or are contained by) a circle centered on a point with a radius.

Arguments

Returns

A table with the following columns:

If geometries are not found for the requested point and radius, geometry_id, timespan, or overlap_type, then null values are returned.

Example

Insert into table denver_census_tracts the census tract boundaries and geom_refs of census tracts which intersect within 10 miles of downtown Denver, Colorado.

1
2
3
4
5
6
INSERT INTO denver_census_tracts(the_geom, geom_refs)
SELECT *
FROM OBS_GetBoundariesByPointAndRadius(
  CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado
  10000 * 1.609, -- 10 miles (10km * conversion to miles)
  'us.census.tiger.census_tract')

Errors

• If a geometry other than a point is passed, an error is thrown. E.g., Invalid geometry type (ST_Line), expecting 'ST_Point'

OBS_GetPointsByPointAndRadius(point geometry, radius numeric, boundary_id text)

The OBS_GetPointsByPointAndRadius(point, radius, boundary_id) method returns point geometries on boundaries (e.g., a point that lies on a Census tract) and their geographical identifiers that intersect (or are contained by) a circle centered on a point with a radius.

Arguments

Returns

A table with the following columns:

If geometries are not found for the requested point and radius, geometry_id, timespan, or overlap_type, then null values are returned.

Example

Insert into table denver_tract_points points on US census tracts and their corresponding geoids for census tracts which intersect within 10 miles of downtown Denver, Colorado, USA.

1
2
3
4
5
6
INSERT INTO denver_tract_points(the_geom, geom_refs)
SELECT *
FROM OBS_GetPointsByPointAndRadius(
  CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado
  10000 * 1.609, -- 10 miles (10km * conversion to miles)
  'us.census.tiger.census_tract')

Errors

• If a geometry other than a point is passed, an error is thrown. E.g., Invalid geometry type (ST_Line), expecting 'ST_Point'

Discovery Functions

If you are using the discovery methods from the Data Observatory, use the following functions to retrieve boundary and measures data.

OBS_Search(search_term)

Use arbitrary text to search all available measures

Arguments

Returns

A TABLE containing the following properties

Example

1
SELECT * FROM OBS_Search('home value')

OBS_GetAvailableBoundaries(point_geometry)

Returns available boundary_ids at a given point geometry.

Arguments

Returns

A TABLE containing the following properties

Example

1
SELECT * FROM OBS_GetAvailableBoundaries(CDB_LatLng(40.7, -73.9))

OBS_GetAvailableNumerators(bounds, filter_tags, denom_id, geom_id, timespan)

Return available numerators within a boundary and with the specified filter_tags.

Arguments

Returns

A TABLE containing the following properties

Examples

Obtain all numerators that are available within a small rectangle.

1
2
SELECT * FROM OBS_GetAvailableNumerators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326))

Obtain all numerators that are available within a small rectangle and are for the United States only.

1
2
SELECT * FROM OBS_GetAvailableNumerators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), '{section/tags.united_states}');

Obtain all numerators that are available within a small rectangle and are employment related for the United States only.

1
2
SELECT * FROM OBS_GetAvailableNumerators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), '{section/tags.united_states, subsection/tags.employment}');

Obtain all numerators that are available within a small rectangle and are related to both employment and age & gender for the United States only.

1
2
SELECT * FROM OBS_GetAvailableNumerators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), '{section/tags.united_states, subsection/tags.employment, subsection/tags.age_gender}');

Obtain all numerators that work with US population (us.census.acs.B01003001) as a denominator.

1
2
3
SELECT * FROM OBS_GetAvailableNumerators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, 'us.census.acs.B01003001')
WHERE valid_denom IS True;

Obtain all numerators that work with US states (us.census.tiger.state) as a geometry.

1
2
3
SELECT * FROM OBS_GetAvailableNumerators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, NULL, 'us.census.tiger.state')
WHERE valid_geom IS True;

Obtain all numerators available in the timespan 2011 - 2015.

1
2
3
SELECT * FROM OBS_GetAvailableNumerators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, NULL, NULL, '2011 - 2015')
WHERE valid_timespan IS True;

OBS_GetAvailableDenominators(bounds, filter_tags, numer_id, geom_id, timespan)

Return available denominators within a boundary and with the specified filter_tags.

Arguments

Returns

A TABLE containing the following properties

Examples

Obtain all denominators that are available within a small rectangle.

1
2
SELECT * FROM OBS_GetAvailableDenominators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326));

Obtain all denominators that are available within a small rectangle and are for the United States only.

1
2
SELECT * FROM OBS_GetAvailableDenominators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), '{section/tags.united_states}');

Obtain all denominators for male population (us.census.acs.B01001002).

1
2
3
SELECT * FROM OBS_GetAvailableDenominators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, 'us.census.acs.B01001002')
WHERE valid_numer IS True;

Obtain all denominators that work with US states (us.census.tiger.state) as a geometry.

1
2
3
SELECT * FROM OBS_GetAvailableDenominators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, NULL, 'us.census.tiger.state')
WHERE valid_geom IS True;

Obtain all denominators available in the timespan 2011 - 2015.

1
2
3
SELECT * FROM OBS_GetAvailableDenominators(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, NULL, NULL, '2011 - 2015')
WHERE valid_timespan IS True;

OBS_GetAvailableGeometries(bounds, filter_tags, numer_id, denom_id, timespan, number_geometries)

Return available geometries within a boundary and with the specified filter_tags.

Arguments

Returns

A TABLE containing the following properties

Examples

Obtain all geometries that are available within a small rectangle.

1
2
SELECT * FROM OBS_GetAvailableGeometries(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326));

Obtain all geometries that are available within a small rectangle and are for the United States only.

1
2
SELECT * FROM OBS_GetAvailableGeometries(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), '{section/tags.united_states}');

Obtain all geometries that work with total population (us.census.acs.B01003001).

1
2
3
SELECT * FROM OBS_GetAvailableGeometries(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, 'us.census.acs.B01003001')
WHERE valid_numer IS True;

Obtain all geometries with timespan 2015.

1
2
3
SELECT * FROM OBS_GetAvailableGeometries(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, NULL, NULL, '2015')
WHERE valid_timespan IS True;

OBS_GetAvailableTimespans(bounds, filter_tags, numer_id, denom_id, geom_id)

Return available timespans within a boundary and with the specified filter_tags.

Arguments

Returns

A TABLE containing the following properties

Examples

Obtain all timespans that are available within a small rectangle.

1
2
SELECT * FROM OBS_GetAvailableTimespans(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326));

Obtain all timespans for total population (us.census.acs.B01003001).

1
2
3
SELECT * FROM OBS_GetAvailableTimespans(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, 'us.census.acs.B01003001')
WHERE valid_numer IS True;

Obtain all timespans that work with US states (us.census.tiger.state) as a geometry.

1
2
3
SELECT * FROM OBS_GetAvailableTimespans(
  ST_MakeEnvelope(-74, 41, -73, 40, 4326), NULL, NULL, NULL, 'us.census.tiger.state')
WHERE valid_geom IS True;