Sign in
Datasets - Analysis

Analysis Materialize Endpoint

Changed on

Materialize an analysis result as a new private dataset (async job).

Requires the upload and export permissions (this endpoint creates a dataset that carries the source's attributes) and read visibility on the source dataset; the new dataset is owned by the caller and counted against their dataset quota (the atomic slot reservation runs at registration inside the worker). Poll GET /jobs/{job_id} for progress.

post/datasets/{dataset_id}/analysis/materialize/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

dataset_idstring uuid required

Request body

operation'buffer' | 'centroid' | 'clip' | 'dissolve' | 'spatial_join' | 'measure' | 'select_by_location' | 'intersect' required
titlestring required
distance_metersnumber nullable

Buffer distance in meters (buffer only)

maskobject nullable

GeoJSON Polygon or MultiPolygon geometry in EPSG:4326 (clip and select_by_location)

mask_dataset_idstring uuid nullable

Polygon dataset supplying the second layer: the area clipped to, selected against, or overlaid with. For clip and select_by_location it is the alternative to mask; for intersect it is REQUIRED and mask is rejected, because an overlay carries the second layer's attributes onto its output and a drawn polygon has none.

by_fieldstring nullable

Optional group-by column for dissolve

join_dataset_idstring uuid nullable

Dataset to join against; each source feature gains a count of the features from it that intersect (spatial_join only)

join_fieldsstring[] nullable

Columns to copy from the intersecting join feature, prefixed 'join_' in the output. Ties break on the lowest join-layer gid (spatial_join only)

filterobject nullable

CQL2-JSON filter on the source dataset, in the language /collections/{dataset_id}/items accepts as filter-lang=cql2-json. Only the features it keeps are analysed, counted, and checked against the operation's size limit.

mask_filterobject nullable

CQL2-JSON filter on the mask_dataset_id layer: only its matching features form the mask or overlay. Requires mask_dataset_id.

join_filterobject nullable

CQL2-JSON filter on the join layer: only its matching features are joined (spatial_join only).

Response

Successful Response

job_idstring uuid required
statusstring required

Changes

  • a9f1b20e3ac9Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property