Validate Dataset

GET

/datasets/{dataset_id}/validate/

const url = 'https://example.com/api/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/validate/?refresh=false';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url 'https://example.com/api/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/validate/?refresh=false' \
  --header 'Authorization: Bearer <token>'

Get validation status for a dataset. Shows hard errors and soft warnings.

By default returns the quality score persisted at ingest time. Pass ?refresh=true to recompute and persist a fresh score (expensive on large tables — issues a full scan per non-geometry column coalesced into a single query).

Authorizations

OAuth2PasswordBearer

Parameters

Path Parameters

dataset_id

required

Dataset Id

string format: uuid

Query Parameters

refresh

Refresh

Recompute the quality score instead of returning the cached value.

boolean

Recompute the quality score instead of returning the cached value.

Responses

200

Successful Response

application/json

ValidationResultResponse

object

is_valid

required

Is Valid

boolean

errors

required

Errors

Array<object>

ValidationIssue

object

field

required

Field

string

message

required

Message

string

severity

required

Severity

string

Allowed values: error warning

warnings

required

Warnings

Array<object>

ValidationIssue

object

field

required

Field

string

message

required

Message

string

severity

required

Severity

string

Allowed values: error warning

quality_score

Any of:

object
null

object

key

additional properties

any

Example

{
  "errors": [
    {
      "severity": "error"
    }
  ],
  "warnings": [
    {
      "severity": "error"
    }
  ]
}

400

Bad request — invalid payload

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}

401

Unauthorized — missing or invalid credentials

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}

403

Forbidden — caller lacks write access

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}

404

Not found

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}

409

Conflict — resource state prevents the operation

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}

422

Validation error

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}

500

Internal server error

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}