Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
AI Lake
AI Assistant
Agents
Other
    Other
      Convert a geo file to GeoParquet formatpostUpload a geo collection file to the staging areapostImport custom geo collectionpost(BETA) Collect physical table and column statistics from a StarRocks data sourcepostSet CertificationpostGet all Custom Geo CollectionsgetPost Custom Geo CollectionspostGet Custom Geo CollectiongetPut Custom Geo CollectionputDelete Custom Geo CollectiondeletePatch Custom Geo Collectionpatch(BETA) Retrieve stored physical statistics for a data sourceget(BETA) Store physical table and column statistics for a data sourceput(BETA) Delete stored physical statistics for a data sourcedeleteGet user data filtersgetSet user data filtersputGet collection featuresgetGet custom collection featuresget
Schemas
powered by Zudoku
OpenAPI definition

Other

Endpoint:/

Convert a geo file to GeoParquet format

POST
/api/v1/actions/customGeoCollection/convert

Converts a geo file from the staging area to GeoParquet format. Supported source formats: GeoJSON (.geojson, .json), ESRI Shapefile (.zip). If the source file is already in GeoParquet format, the same location is returned without conversion.

Convert a geo file to GeoParquet format › Request Body

  • locationstring · minLength: 1 · required

    Location of the file in the staging area to convert.

Convert a geo file to GeoParquet format › Responses

Conversion was successful.

  • locationstring · required

    Location of the converted GeoParquet file in the staging area.

POST /api/v1/actions/customGeoCollection/convert

Upload a geo collection file to the staging area

POST
/api/v1/actions/customGeoCollection/staging/upload

Provides a location for uploading staging files for custom geo collections. Supported file types: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip). Maximum file size: 100 MB.

Upload a geo collection file to the staging area › Request Body

  • filestring · required

Upload a geo collection file to the staging area › Responses

Upload was successful.

  • locationstring · required

    Location to use when referencing the uploaded file in subsequent requests.

POST /api/v1/actions/customGeoCollection/staging/upload

Import custom geo collection

POST
/api/v1/actions/customGeoCollection/{collectionId}/import

Import a geo collection file from the staging area to be available for use. The file must be in GeoParquet format (use the convert endpoint first for other formats). Validates file size (max 100 MB), organization storage quota (max 1 GB total), and GeoParquet schema (requires id, geometry, and bbox columns).

Import custom geo collection › path Parameters

  • collectionIdstring · required

Import custom geo collection › Request Body

  • locationstring · required

    Location of the file in the staging area.

Import custom geo collection › Responses

Successful import.

  • versioninteger · int32 · required

    The version of the imported geo collection.

POST /api/v1/actions/customGeoCollection/{collectionId}/import

(BETA) Collect physical table and column statistics from a StarRocks data source

POST
/api/v1/actions/dataSources/{dataSourceId}/scanStatistics

(BETA) Reads pre-computed CBO statistics from StarRocks. Supports both internal catalog (native/PIPE tables) and external catalog (Iceberg tables). Statistics include row counts, data sizes, NDV (number of distinct values), null counts, and min/max values.

(BETA) Collect physical table and column statistics from a StarRocks data source › path Parameters

  • dataSourceIdstring · required

(BETA) Collect physical table and column statistics from a StarRocks data source › Request Body

  • schematastring[] · required
  • tableNamesstring[]

(BETA) Collect physical table and column statistics from a StarRocks data source › Responses

OK

  • tablesobject[] · required
  • warningsobject[] · required
POST /api/v1/actions/dataSources/{dataSourceId}/scanStatistics

Set Certification

POST
/api/v1/actions/workspaces/{workspaceId}/setCertification

Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission.

Set Certification › path Parameters

  • workspaceIdstring · required

Set Certification › Request Body

  • idstring · required

    ID of the entity.

    Example: total-sales
  • typestring · enum · required

    Type of the entity.

    Enum values:
    metric
    visualizationObject
    analyticalDashboard
    computedAttribute
  • messagestring | null

    Optional message associated with the certification.

  • statusstring | null · enum

    Certification status of the entity.

    Enum values:
    CERTIFIED

Set Certification › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/setCertification

Get all Custom Geo Collections

GET
/api/v1/entities/customGeoCollections

Get all Custom Geo Collections › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    page
    all
    ALL

Get all Custom Geo Collections › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/customGeoCollections

Post Custom Geo Collections

POST
/api/v1/entities/customGeoCollections

Post Custom Geo Collections › Request Body

  • dataobject · required

    JSON:API representation of customGeoCollection entity.

Post Custom Geo Collections › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of customGeoCollection entity.

  • linksobject
POST /api/v1/entities/customGeoCollections

Get Custom Geo Collection

GET
/api/v1/entities/customGeoCollections/{id}

Get Custom Geo Collection › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Custom Geo Collection › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get Custom Geo Collection › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of customGeoCollection entity.

  • linksobject
GET /api/v1/entities/customGeoCollections/{id}

Put Custom Geo Collection

PUT
/api/v1/entities/customGeoCollections/{id}

Put Custom Geo Collection › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put Custom Geo Collection › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Put Custom Geo Collection › Request Body

  • dataobject · required

    JSON:API representation of customGeoCollection entity.

Put Custom Geo Collection › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of customGeoCollection entity.

  • linksobject
PUT /api/v1/entities/customGeoCollections/{id}

Delete Custom Geo Collection

DELETE
/api/v1/entities/customGeoCollections/{id}

Delete Custom Geo Collection › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete Custom Geo Collection › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/customGeoCollections/{id}

Patch Custom Geo Collection

PATCH
/api/v1/entities/customGeoCollections/{id}

Patch Custom Geo Collection › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch Custom Geo Collection › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch Custom Geo Collection › Request Body

  • dataobject · required

    JSON:API representation of patching customGeoCollection entity.

Patch Custom Geo Collection › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of customGeoCollection entity.

  • linksobject
PATCH /api/v1/entities/customGeoCollections/{id}

(BETA) Retrieve stored physical statistics for a data source

GET
/api/v1/layout/dataSources/{dataSourceId}/statistics

(BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.

(BETA) Retrieve stored physical statistics for a data source › path Parameters

  • dataSourceIdstring · required

(BETA) Retrieve stored physical statistics for a data source › query Parameters

  • schemaNamestring
  • tableNamestring

(BETA) Retrieve stored physical statistics for a data source › Responses

OK

  • tablesobject[] · required
GET /api/v1/layout/dataSources/{dataSourceId}/statistics

(BETA) Store physical table and column statistics for a data source

PUT
/api/v1/layout/dataSources/{dataSourceId}/statistics

(BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.

(BETA) Store physical table and column statistics for a data source › path Parameters

  • dataSourceIdstring · required

(BETA) Store physical table and column statistics for a data source › Request Body

  • tablesobject[] · required

(BETA) Store physical table and column statistics for a data source › Responses

Statistics stored successfully.

No data returned
PUT /api/v1/layout/dataSources/{dataSourceId}/statistics

(BETA) Delete stored physical statistics for a data source

DELETE
/api/v1/layout/dataSources/{dataSourceId}/statistics

(BETA) Removes all stored physical statistics for the specified data source.

(BETA) Delete stored physical statistics for a data source › path Parameters

  • dataSourceIdstring · required

(BETA) Delete stored physical statistics for a data source › Responses

Statistics deleted.

No data returned
DELETE /api/v1/layout/dataSources/{dataSourceId}/statistics

Get user data filters

GET
/api/v1/layout/workspaces/{workspaceId}/userDataFilters

Retrieve current user data filters assigned to the workspace.

Get user data filters › path Parameters

  • workspaceIdstring · required

Get user data filters › Responses

Retrieved current user data filters.

  • userDataFiltersobject[] · required
GET /api/v1/layout/workspaces/{workspaceId}/userDataFilters

Set user data filters

PUT
/api/v1/layout/workspaces/{workspaceId}/userDataFilters

Set user data filters assigned to the workspace.

Set user data filters › path Parameters

  • workspaceIdstring · required

Set user data filters › Request Body

  • userDataFiltersobject[] · required

Set user data filters › Responses

User data filters successfully set.

No data returned
PUT /api/v1/layout/workspaces/{workspaceId}/userDataFilters

Get collection features

GET
/api/v1/location/collections/{collectionId}/items

Retrieve features from a GeoCollections collection as GeoJSON

Get collection features › path Parameters

  • collectionIdstring · required

    Collection identifier

Get collection features › query Parameters

  • limitinteger · min: 1 · max: 100

    Maximum number of features to return

  • bboxstring

    Bounding box filter (minx,miny,maxx,maxy)

  • valuesstring[]

    List of values to filter features by

Get collection features › Responses

Features retrieved successfully

  • featuresobject[] · required
  • typestring · required
  • bboxnumber[]
GET /api/v1/location/collections/{collectionId}/items

Get custom collection features

GET
/api/v1/location/custom/collections/{collectionId}/items

Retrieve features from a custom (organization-scoped) GeoCollections collection as GeoJSON

Get custom collection features › path Parameters

  • collectionIdstring · required

    Collection identifier

Get custom collection features › query Parameters

  • limitinteger · min: 1 · max: 100

    Maximum number of features to return

  • bboxstring

    Bounding box filter (minx,miny,maxx,maxy)

  • valuesstring[]

    List of values to filter features by

Get custom collection features › Responses

Features retrieved successfully

  • featuresobject[] · required
  • typestring · required
  • bboxnumber[]
GET /api/v1/location/custom/collections/{collectionId}/items
Agents