Skip to content
getgeolens.com

Visibility Check Endpoint

GET
/maps/{map_id}/visibility-check/
curl --request GET \
--url https://example.com/maps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/visibility-check/ \
--header 'Authorization: Bearer <token>'

Check which layers a map’s audience can’t see. Informational only.

Owner-or-admin, since the answer names datasets that read access alone must not reveal. Unreadable maps answer 404; readable non-owners get 403.

map_id
required
Map Id
string format: uuid

Successful Response

Media type application/json
VisibilityCheckResponse
object
non_public_datasets
required
Non Public Datasets

Titles of datasets not publicly visible

Array<string>
has_non_public
required
Has Non Public

True if any layer references a non-public dataset

boolean
hidden_from_groups
Hidden From Groups

On a restricted map, the layers some of its groups can’t read, among those the caller reads. Empty on other maps, and when the permission authority can’t say who reads a dataset.

Array<object>
MapLayerAccessGap
object
layer_id
required
Layer Id
string format: uuid
layer_title
required
Layer Title
string
dataset_id
required
Dataset Id
string format: uuid
dataset_title
required
Dataset Title
string
group_ids
required
Group Ids

The map’s groups that have a member who can’t read it.

Array<string>
can_share
required
Can Share

Whether confirm: share_datasets would share the dataset with those groups.

boolean

Example generated

{
"non_public_datasets": [
"example"
],
"has_non_public": true,
"hidden_from_groups": [
{
"layer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"layer_title": "example",
"dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"dataset_title": "example",
"group_ids": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"can_share": true
}
]
}

Bad request — invalid payload

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

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

Unauthorized — missing or invalid credentials

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

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

Forbidden — caller lacks write access

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

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

Not found

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

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

Conflict — resource state prevents the operation

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

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

Validation error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

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

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

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

Seconds until the request may be retried

Internal server error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

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

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

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