Search

Get aggregated fields

Get aggregated fields from entities.

get/v1/search/aggregate

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/search/aggregate
  • Auth: HTTP bearer

Query parameters

indexstring
fieldstring

Field in an entity.

valuestring

value for searching in aggregation

sourceFieldsstring

List of fields to fetch from _source per bucket.

qstring required

Search Query Text, Pass text for substring match; Pass without wildcards for exact match. <br/> 1. For listing all tables or topics pass q=* <br/>2. For search tables or topics pass q=search_term <br/>3. For searching field names such as search by columnNames pass q=columnNames:address, for searching deleted entities, use q=deleted:true <br/>4. For searching by tag names pass q=tags.tagFQN:user.email <br/>5. When user selects a filter pass q=query_text AND tags.tagFQN:user.email AND platform:MYSQL <br/>6. Search with multiple values of same filter q=tags.tagFQN:user.email AND tags.tagFQN:user.address <br/>NOTE: logic operators such as AND, OR and NOT must be in uppercase

sizeinteger

Size field to limit the no.of results returned, defaults to 10

deletedboolean
queryTextstring

Free-text search query to scope aggregation results

Response

Table Aggregate API

completionboolean
phraseboolean
termboolean

Changes

No recorded changes to this operation across all 1 revision of this API.