Label List
Endpoint for Labels.
Limitations
The response of the root endpoint is sorted by object_id: it is
recommended to use a valid_at filters to have a
deterministic sorting (especially if there are multiple pages). This is
not required for backwards compatibility reasons.
Spatial filtering is limited to a maximum bounding box size of 0.022
degrees (zoom level 14). This limitation goes for all spatial
filters: in_bbox, geom_within, geom_intersects, boundary_id,
boundary_code, and boundary_name. This limitation is ignored if
an object_id is specified.
Custom route: counts
The /labels/counts/ endpoint counts the number of labels per
label_value. It is advisable to use the valid_at filter to not double-
count labels attached to the same object.
The geometric filters have the same limitation as the root endpoint, unless label counts are pre-computed. Contact the service desk to schedule a nightly updated label count cache for a specific label type and set of boundaries.
Custom route: bulkdelete
The /labels/bulkdelete/ endpoint deletes all labels that meet the filter criteria. Labels for which the user has only read privileges cannot be deleted.
Custom route: export
A POST to /labels/export/ endpoint starts a label export to a file. Please consult that endpoint for the documentation.
Query parameters
object_id: Filter on the ID of the labeled object.
valid_at: Return the labels valid at given datetime. Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ.
start/end:
Temporal filter on start and end.
Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ
geom_intersects:
Spatial filter on geometry of labelled objects.
Filter operator is ST_intersects.
Supports WKT, HEXEWKB, and GeoJSON.
in_bbox:
Spatial filter on geometry of labelled objects.
The bounding box format is: min Lat, min Lon, max Lat, max Lon.
Includes labels for objects that overlap the bounding box.
boundary_id:
Filter on geometry of the region with the id boundary_id.
boundary_code:
Filter on geometry of the region with the id boundary_code.
boundary_type:
Spatial filter on geometry, whereby geometry is specified by an
region object (see below) and filter operator is
ST_Intersects. Available types are COUNTRY, PROVINCE, WATER_BOARD,
MUNICIPALITY, CATCHMENT, POLDER, FIXED_DRAINAGE_LEVEL_AREA,
PUMPED_DRAINAGE_AREA, MAIN_PUMPED_DRAINAGE_AREA, DISTRICT,
NEIGHBOURHOOD, CADASTRE, PLANTATION, FIELD, CITY, and CUSTOM
boundary_name:
Filter on name of the region with the name
boundary_name. Requires boundary_type.
simplify: Simplify the query geometries (in WGS84) using this value as tolerance. A higher value may result in a better response time for detailed geometries. Defaults to 0.00001 degrees (approx. 1 meter).
created:
Temporal filter on created. Supports various lookup types
(exact, lt, lte, gt, gte; created__exact by default).
Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.
Examples
?object_id=498521
?object_id=498521&valid_at=2019-01-01T02:03:04Z
?object_id=498521&start=2019-01-01T02:03:04Z
?start__lte=2019-01-01T02:03:04Z
?end__gte=2019-01-01T02:03:04Z
?end__lt=2019-01-02T02:03:04Z&start__gt=2019-01-01T02:03:04Z
?valid_at=2019-01-02T02:03:00Z
?geom_intersects=POLYGON((4.87 52.73, 4.87 52.75, 4.89 52.75, 4.89 52.73, 4.87 52.73))
?geometry__intersects=POINT (5 52)
?boundary__id=198
?boundary__code=NL_GM0344
?boundary__type=CITY&boundary__name=Utrecht
?created__gte=2017-01-01T00:00:00Z
Sub-endpoints
counts/?valid_at=2019-01-01T02:03:04Z
counts/?boundary_id=198&valid_at=2019-01-01T02:03:04Z
bulkdelete/
GET /api/v4/labeltypes/e23c58ea-ae39-41bf-9867-021a996034b8/labels/?format=api
{ "count": 324, "next": "https://demo.lizard.net/api/v4/labeltypes/e23c58ea-ae39-41bf-9867-021a996034b8/labels/?format=api&page=2", "previous": null, "results": [ { "label_value": "A", "object_type": "building", "object_id": 11424133, "created": "2019-07-30T08:39:12.848152Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775798, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "A", "label_pluvial_score": 0, "label_pluvial_value": 0.0, "label_groundwater_label": "C", "label_groundwater_score": 10, "label_groundwater_value": 0.5750000476837158 } }, { "label_value": "A", "object_type": "building", "object_id": 11424136, "created": "2019-07-30T08:39:12.865912Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775808, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "A", "label_pluvial_score": 0, "label_pluvial_value": 0.0, "label_groundwater_label": "A", "label_groundwater_score": 0, "label_groundwater_value": 0.8073076605796814 } }, { "label_value": "A", "object_type": "building", "object_id": 11424139, "created": "2019-07-30T08:39:12.875044Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775803, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "B", "label_pluvial_score": 5, "label_pluvial_value": 0.07500000298023224, "label_groundwater_label": "A", "label_groundwater_score": 0, "label_groundwater_value": 0.8073076605796814 } }, { "label_value": "A", "object_type": "building", "object_id": 11424141, "created": "2019-07-30T08:39:12.883910Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775803, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "B", "label_pluvial_score": 5, "label_pluvial_value": 0.07500000298023224, "label_groundwater_label": "A", "label_groundwater_score": 0, "label_groundwater_value": 0.8073076605796814 } }, { "label_value": "A", "object_type": "building", "object_id": 11424424, "created": "2019-07-30T08:39:12.996409Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775808, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "A", "label_pluvial_score": 0, "label_pluvial_value": 0.0, "label_groundwater_label": "A", "label_groundwater_score": 0, "label_groundwater_value": 0.8073076605796814 } }, { "label_value": "A", "object_type": "building", "object_id": 11424428, "created": "2019-07-30T08:39:13.181998Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775808, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "A", "label_pluvial_score": 0, "label_pluvial_value": 0.0, "label_groundwater_label": "A", "label_groundwater_score": 0, "label_groundwater_value": 0.8403847217559814 } }, { "label_value": "A", "object_type": "building", "object_id": 11424434, "created": "2019-07-30T08:39:13.048288Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775808, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "A", "label_pluvial_score": 0, "label_pluvial_value": 0.0, "label_groundwater_label": "A", "label_groundwater_score": 0, "label_groundwater_value": 0.8073076605796814 } }, { "label_value": "A", "object_type": "building", "object_id": 11424447, "created": "2019-07-30T08:39:13.258083Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775808, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "A", "label_pluvial_score": 0, "label_pluvial_value": 0.0, "label_groundwater_label": "A", "label_groundwater_score": 0, "label_groundwater_value": 0.9884615540504456 } }, { "label_value": "A", "object_type": "building", "object_id": 11424450, "created": "2019-07-30T08:39:13.270822Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775788, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "E", "label_pluvial_score": 20, "label_pluvial_value": 0.30000001192092896, "label_groundwater_label": "A", "label_groundwater_score": 0, "label_groundwater_value": 0.9884615540504456 } }, { "label_value": "A", "object_type": "building", "object_id": 11424454, "created": "2019-07-30T08:39:13.307416Z", "start": "2019-07-30T00:00:00Z", "end": null, "extra": { "label_score": -9223372036854775808, "fluvial_label_value": null, "label_fluvial_label": "A", "label_fluvial_score": -9223372036854775808, "label_pluvial_label": "A", "label_pluvial_score": 0, "label_pluvial_value": 0.0, "label_groundwater_label": "A", "label_groundwater_score": 0, "label_groundwater_value": 0.8973076939582825 } } ] }