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

AnalyticsSearchPayloadBulkLookup

object

Bulk lookup of entities matching the values.

typestringrequired

The entity type.

filtersarray[object]required

The values to lookup.

>= 1 items<= 1000 items

Example

SearchPayload

Search request payload
Use query when you want to search for targeted, full-text or filtered search using Lucene-like syntax. This is ideal for searching across multiple fields, applying logical operators, or when you need advanced filtering capabilities.
example: type:consumer AND name:us-control-west2 AND @scope:realm

Use bulk_lookup when you need to retrieve more entities by a specific set of attribute values, such as a list of IDs or other unique keys.
example: Retrieve details for a list of known user IDs or system accounts.

Only one of query or bulk_lookup should be provided per request.

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