API Reference

Query metrics

post
https://api.controlup.com/vdi/realtime/v1/metrics/query

Retrieves realtime metrics data with optional filtering, sorting, pagination, and aggregation capabilities

Body Params
string
required

The metrics table to query

match
array of objects
required

Text search filters applied to specific fields

match*
sort
array of objects
required

Sorting criteria for the results

sort*
fields
array of objects
required

List of metric fields to include in the query response. Each item requires a "field" property specifying the metric name.

fields*
page
object

Pagination settings for the query results

where
object

Complex filtering conditions (And/Or/Not tree)

options
object

Advanced query execution and configuration options

string

Focus context for the query (e.g. scoping to a specific view)

Responses

Updated 3 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago

Did this page help you?