SearchResponse

object

Search response schema.

dataarray[object]

Item included in the list of search results.

Show Child Parameters
metaobject

Pagination metadata.

Show Child Parameters
Example

SearchResultItem

object

Item included in the list of search results.

idstringrequired

Unique identifier for the record.

typestringrequired

Konnect entity type.

namestringrequired

Name of the entity.

descriptionstring

Description of the entity.

labelsobject

Labels for the entity.

relationsobject

Relations for the entity.

attributesobject

Attributes for the entity.

matchstring

The matched text from the record.

relations_listarray[object]

The relations tree with child and sibling relations.

Show Child Parameters
Example

AnalyticsSearchPayload

Analytics search request payload

One Of
querystringrequired

The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.

Example:type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)

Example

AnalyticsSearchPayloadQueryRequest

object
querystringrequired

The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.

Example:type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)

Example

AnalyticsSearchPayloadBulkLookupRequest

object
bulk_lookupobjectrequired

Bulk lookup of entities matching the values.

Show Child Parameters
Example