Skip to content
AveraAveraAvera Documentation

Execute query summary

POST
/api/v1/livedoc/query/summary
curl --request POST \
  --url https://app.avera.io/api/v1/livedoc/query/summary \
  --header 'Content-Type: application/json' \
  --data '{ "metrics": [ { "id": "example", "label": "example", "expression": "example", "description": "example", "icon": "example", "color": "example", "format": { "type": "example", "pattern": "example", "prefix": "example", "suffix": "example" }, "thresholds": [ { "value": 1, "color": "example", "operator": "example" } ] } ] }'

Execute a summary query and return metric values

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
metrics
required
Array<object>
object
id
required
string
label
required
string
expression
required
string
description
string | null
icon
string | null
color
string | null
format
One of:
object
type
required
string
pattern
string | null
prefix
string | null
suffix
string | null
thresholds
Array<object> | null
object
value
required
number format: double
color
required
string
operator
string | null

Example generated

{
  "metrics": [
    {
      "id": "example",
      "label": "example",
      "expression": "example",
      "description": "example",
      "icon": "example",
      "color": "example",
      "format": {
        "type": "example",
        "pattern": "example",
        "prefix": "example",
        "suffix": "example"
      },
      "thresholds": [
        {
          "value": 1,
          "color": "example",
          "operator": "example"
        }
      ]
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
values
required
object
key
additional properties
object
value
null
formattedValue
required
string
color
string | null
error
string | null
evaluatedAt
required
string format: date-time
executionTimeMs
required
integer format: int64