Searches Dataverse content

get

https://{dataverseHost}/api/search

Searches dataverses, datasets, and files using query text, type filters, subtree filters, facets, sorting, and pagination options.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

array of strings

Filter query.

geo_point

string

Geographic point used for spatial search.

geo_radius

string

Geographic radius used for spatial search.

metadata_fields

array of strings

Metadata fields to include.

metadata_fields

order

string

Sort order.

per_page

int32

Number of results to return per page.

string

Search query string.

query_entities

boolean

Defaults to true

Whether search queries entity fields.

search_service

string

Search service name to use.

show_api_urls

boolean

Whether API URLs are included.

show_collections

boolean

Whether collection results are included.

show_entity_ids

boolean

Whether entity ids are included.

show_facets

boolean

Whether facet counts are included.

show_relevance

boolean

Whether relevance scores are included.

show_type_counts

boolean

Whether object type counts are included.

sort

string

Sort field.

start

int32

Result offset.

subtree

array of strings

Dataverse subtree alias filter.

subtree

type

array of strings

Resource type filter.

type

Response

200

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!