Skip to content
Site Qwality Site Qwality Site Qwality Docs

query_metrics

POST
/metrics/v2/query
 
curl --request POST \
  --url https://api.siteqwality.com/metrics/v2/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "v": 1, "queries": [ { "id": "example", "metric": "example", "filters": [ "example" ], "time_agg": "merge", "space_agg": "merge", "group_by": [ "example" ], "limit": 1 } ], "formulas": [ { "id": "example", "expr": "example", "alias": "example", "unit": "ms", "hidden": true } ], "range": { "from": "example", "to": "example" }, "interval": "example", "compare": "example", "show": [ "example" ] }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json

A metrics query: lettered queries, formulas over them, one window.

object
v
required
integer format: int32
queries
required
Array<object>
object
id
required
string
metric
required
string
filters

The f grammar in metrics scope.

Array<string>
time_agg
One of:

Absent: the default for the metric’s type (histograms: merge, merge).

string
Allowed values: merge avg min max sum count last rate increase p50 p75 p90 p95 p99
space_agg
One of:
string
Allowed values: merge avg sum min max count p50 p75 p90 p95 p99
group_by
Array<string>
limit

Top N series, at most 500.

integer | null format: int32
formulas
Array<object>
object
id
required
string
expr
required
string
alias
string | null
unit
One of:
string
Allowed values: ms seconds percent count bytes score per_second none
hidden
boolean
range
required

A window of T2 tokens (now, now-2h) or instants (ISO 8601, epoch milliseconds), resolved when the query is compiled, so a stored view stays rolling.

object
from
required
string
to
required
string
interval

A T2 bucket interval or auto.

string | null
compare

Overlay the same query this long ago, as 1w.

string | null
show

Query and formula ids to draw; empty draws the formulas, or every query when none.

Array<string>

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
series
required
Array<object>
object
id
required
string
alias
string | null
groups
required
object
key
additional properties
string | null
unit
required
string
comparison
required
boolean
points
required
Array<object>
object
timestamp
required
string
value
number | null format: double
histogram
One of:
object
temporality
required
string
layout
required
string
layout_id
required
string
count
required
string
sum
number | null format: double
min
number | null format: double
max
number | null format: double
bounds
required
Array<number>
bucket_counts
required
Array<string>
scale
required
integer format: int32
zero_count
required
string
positive
required
object
key
additional properties
string
negative
required
object
key
additional properties
string
flags
required
Array<string>
exemplars
required
Array<object>
object
query_id
required
string
series_id
required
string
timestamp
required
string
value
number | null format: double
trace_id
required
string
span_id
required
string
attributes
required
object
key
additional properties
string
step_seconds
required
integer format: int64
truncated
required
boolean
source
required
string
precision
required
string
meta
required
object
from
required
string
to
required
string
clamped_from
string | null
partial
required
boolean
slow_terms
required
Array<string>
Example generated
{
  "series": [
    {
      "id": "example",
      "alias": "example",
      "groups": {
        "additionalProperty": "example"
      },
      "unit": "example",
      "comparison": true,
      "points": [
        {
          "timestamp": "example",
          "value": 1,
          "histogram": {
            "temporality": "example",
            "layout": "example",
            "layout_id": "example",
            "count": "example",
            "sum": 1,
            "min": 1,
            "max": 1,
            "bounds": [
              1
            ],
            "bucket_counts": [
              "example"
            ],
            "scale": 1,
            "zero_count": "example",
            "positive": {
              "additionalProperty": "example"
            },
            "negative": {
              "additionalProperty": "example"
            }
          },
          "flags": [
            "example"
          ]
        }
      ]
    }
  ],
  "exemplars": [
    {
      "query_id": "example",
      "series_id": "example",
      "timestamp": "example",
      "value": 1,
      "trace_id": "example",
      "span_id": "example",
      "attributes": {
        "additionalProperty": "example"
      }
    }
  ],
  "step_seconds": 1,
  "truncated": true,
  "source": "example",
  "precision": "example",
  "meta": {
    "from": "example",
    "to": "example",
    "clamped_from": "example",
    "partial": true,
    "slow_terms": [
      "example"
    ]
  }
}

Privacy Cookie preferences