Skip to content
getgeolens.com
GeoLens Docs

Add Layer Endpoint

POST
/maps/{map_id}/layers/
 
curl --request POST \
  --url https://example.com/api/maps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layers/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sort_order": 0, "visible": true, "opacity": 1, "paint": {}, "layout": {}, "display_name": "example", "filter": [ "example" ], "label_config": {}, "popup_config": { "enabled": true, "expression": "example", "visible_fields": [ "example" ] }, "style_config": {}, "layer_type": "example", "show_in_legend": true }'

Add a layer to a map.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
map_id
required
Map Id
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json
MapLayerInput
object
dataset_id
required
Dataset Id
string format: uuid
sort_order
Sort Order

Draw order (lower draws first)

integer
0 <= 32767
visible
Visible
boolean
default: true
opacity
Opacity

Layer opacity 0.0-1.0

number
default: 1 <= 1
paint
Any of:
object
key
additional properties
any
layout
Any of:
object
key
additional properties
any
display_name
Any of:
string
<= 255 characters
filter
Any of:
Array
label_config
Any of:
object
key
additional properties
any
popup_config
Any of:
PopupConfig

Per-layer popup configuration: enable/disable + custom title template

  • ordered visible-fields allowlist. Persisted as JSONB on map_layers.
object
enabled
required
Enabled
boolean
expression
Any of:
string
<= 500 characters
visible_fields
Any of:
Array<string>
<= 100 items
style_config
Any of:
object
key
additional properties
any
layer_type
Any of:
string
/^(vector_geolens|raster_geolens|geojson)$/
show_in_legend
Show In Legend

Whether to include in the map legend

boolean
default: true

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Media type application/json
MapLayerResponse
object
id
required
Id
string format: uuid
dataset_id
required
Dataset Id
string format: uuid
dataset_name
required
Dataset Name
string
dataset_geometry_type
required
Any of:
string
dataset_table_name
required
Dataset Table Name
string
dataset_extent_bbox
required
Any of:
Array<number>
dataset_column_info
Any of:
Array<object>
object
key
additional properties
any
dataset_feature_count
Any of:
integer
dataset_sample_values
Any of:
object
key
additional properties
any
display_name
Any of:
string
sort_order
required
Sort Order
integer
visible
required
Visible
boolean
opacity
required
Opacity
number
paint
required
Paint
object
key
additional properties
any
layout
required
Layout
object
key
additional properties
any
layer_type
Layer Type
string
default: vector_geolens
dataset_record_type
Any of:
string
filter
Any of:
Array
label_config
Any of:
object
key
additional properties
any
popup_config
Any of:
PopupConfig

Per-layer popup configuration: enable/disable + custom title template

  • ordered visible-fields allowlist. Persisted as JSONB on map_layers.
object
enabled
required
Enabled
boolean
expression
Any of:
string
<= 500 characters
visible_fields
Any of:
Array<string>
<= 100 items
style_config
Any of:
object
key
additional properties
any
show_in_legend
Show In Legend
boolean
default: true
is_3d
Any of:
boolean
Example 
{
  "layer_type": "vector_geolens",
  "show_in_legend": true
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}