Skip to content
getgeolens.com
GeoLens Docs

Search Facets Endpoint

GET
/search/facets/
 
curl --request GET \
  --url 'https://example.com/search/facets/?exclude_synthetic=true&spatial_predicate=intersects'

Return record_type facet counts for the given filters.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
q
Any of:
string
<= 1000 characters

Full-text search query

bbox
Any of:
string

Bounding box: minx,miny,maxx,maxy

keywords
Any of:
Array<string>

Filter by keywords

geometry_type
Any of:
string

Filter by geometry type

srid
Any of:
integer

Filter by SRID

source_organization
Any of:
string

Filter by source organization

datetime
Any of:
string

OGC datetime interval

exclude_synthetic
Exclude Synthetic

Exclude synthetic/test datasets

boolean
default: true

Exclude synthetic/test datasets

spatial_predicate
Spatial Predicate

Spatial predicate: intersects or within

string
default: intersects
Allowed values: intersects within

Spatial predicate: intersects or within

geometry
Any of:
string
<= 10000 characters

GeoJSON geometry for spatial filter

collection_id
Any of:
string format: uuid

Filter by collection membership

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
FacetCountResponse

Multi-group facet counts for the search sidebar.

object
record_type
required
Record Type

Hit counts keyed by record type

object
key
additional properties
integer
keywords
Keywords

Top keyword tags with counts

Array<object>
default:
FacetValueCount

A single facet value with count.

object
value
required
Value
string
count
required
Count
integer
source_organization
Source Organization

Top organizations with counts

Array<object>
default:
FacetValueCount

A single facet value with count.

object
value
required
Value
string
count
required
Count
integer
srid
Srid

Top SRIDs with counts

Array<object>
default:
FacetValueCount

A single facet value with count.

object
value
required
Value
string
count
required
Count
integer
collections
Collections

Collections containing matched records

Array<object>
default:
CollectionFacetItem

A collection facet entry.

object
id
required
Id
string
name
required
Name
string
dataset_count
required
Dataset Count
integer
Example 
{
  "keywords": [],
  "source_organization": [],
  "srid": [],
  "collections": []
}

401

Section titled “401 ”

Unauthenticated — a credential was supplied and could not be resolved (expired, revoked, or malformed). Sending no credential at all is not an error on these operations; they answer anonymously with the public subset. Neither is sending an unresolvable credential alongside a capability that authorizes the request on its own — a valid X-Embed-Token or a valid signed tile template (sig, exp, scope). Those are served and the unrelated credential is ignored.

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"
}

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": {}
    }
  ]
}

429

Section titled “429 ”

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"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “500 ”

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"
}

503

Section titled “503 ”

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"
}
Privacy Apache 2.0 getgeolens.com