Analysis Preview Endpoint

POST

/datasets/{dataset_id}/analysis/preview/

const url = 'https://example.com/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/analysis/preview/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"distance_meters":1,"mask":{},"mask_dataset_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","operation":"buffer"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/analysis/preview/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "distance_meters": 1, "mask": {}, "mask_dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "operation": "buffer" }'

Run a parameterized PostGIS operation and return a GeoJSON preview.

Synchronous, read-only, and capped: results are for on-map preview, not persistence — use the materialize endpoint to save output as a dataset.

Authorizations

Parameters

Path Parameters

dataset_id

required

Dataset Id

string format: uuid

Request Body^required

application/json

AnalysisPreviewRequest

Parameters for a synchronous analysis preview.

Deliberately flat (no discriminated union) so SDK generators keep the endpoint; per-operation requiredness is enforced by the validator.

object

distance_meters

Any of:

number
null

number

> 0 <= 100000

mask

Any of:

object
null

object

key

additional properties

any

mask_dataset_id

Any of:

string
null

string format: uuid

operation

required

Operation

string

Allowed values: buffer centroid clip

Responses

200

Successful Response

application/json

AnalysisPreviewResponse

GeoJSON FeatureCollection preview of an analysis operation.

object

bbox

Any of:

Array<number>
null

Array<number>

feature_count

required

Feature Count

integer

geojson

required

Geojson

object

key

additional properties

any

source_feature_count

Any of:

integer
null

integer

truncated

required

Truncated

boolean

Example ^generated

{
  "bbox": [
    1
  ],
  "feature_count": 1,
  "geojson": {},
  "source_feature_count": 1,
  "truncated": true
}

400

Bad request — invalid payload

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Unauthorized — missing or invalid credentials

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Forbidden — caller lacks write access

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Not found

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

409

Conflict — resource state prevents the operation

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Validation error

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Too many requests — retry after the advertised interval

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Retry-After

integer

Seconds until the request may be retried

500

Internal server error

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Service unavailable — the database could not serve the request

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Analysis Preview Endpoint

Authorizations

Parameters

Path Parameters

Request Body required

Responses

200

Example generated

400

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

Headers

500

Example

503

Example

Request Body^required

Example ^generated