​

ves-io-schema-observability-synthetic_monitor-CustomAPI-GetMetricQueryData

Published April 5, 2023 | Last modified October 28, 2026

Examples of performing synthetic_monitor CustomAPI GetMetricQueryData

Usecase:

Get Metric Query Data

Request:

Request using vesctl:

vesctl request rpc synthetic_monitor.CustomAPI.GetMetricQueryData -i request.yaml --uri /public/namespaces/{namespace}/metric-query --http-method POST

where file request.yaml has following contents:

endTime: "2020-11-17T13:41:49.083255Z"
metrics:
- field: dnsLookupMs
  function: SUM
  measurement: monitor
  tags:
  - key: region
    values:
    - us-east-1
    - us-west-1
startTime: "2020-11-17T12:41:49.083255Z"
stepSize: 300s

vesctl yaml response:

data: []

Request using curl:

curl -X 'POST' -d '{"start_time":"2020-11-17T12:41:49.083255Z","end_time":"2020-11-17T13:41:49.083255Z","step_size":"300s","metrics":[{"measurement":"monitor","field":"dnsLookupMs","function":"SUM","tags":[{"key":"region","values":["us-east-1","us-west-1"]}]}]}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build3348201650_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/observability/synthetic_monitor/namespaces/%7Bnamespace%7D/metric-query'

curl response:

HTTP/1.1 200 OK
Content-Length: 19
Content-Type: application/json
Date: Mon, 28 Sep 2026 04:25:58 GMT
Vary: Accept-Encoding


{
  "data": [
  ]
}
On this page: