Search Facets Endpoint

GET

/search/facets/

curl --request GET \
  --url 'https://example.com/api/search/facets/?exclude_synthetic=true&spatial_predicate=intersects' \
  --header 'Authorization: Bearer <token>'

Return record_type facet counts for the given filters.

Authorizations

• OAuth2PasswordBearer

Parameters

Query Parameters

q

Any of:

string

string

null

null

Full-text search query

bbox

Any of:

string

string

null

null

Bounding box: minx,miny,maxx,maxy

keywords

Any of:

Array<string>

Array<string>

null

null

Filter by keywords

geometry_type

Any of:

string

string

null

null

Filter by geometry type

srid

Any of:

integer

integer

null

null

Filter by SRID

source_organization

Any of:

string

string

null

null

Filter by source organization

datetime

Any of:

string

string

null

null

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

string

null

null

GeoJSON geometry for spatial filter

collection_id

Any of:

string

string format: uuid

null

null

Filter by collection membership

Responses

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

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