The query catalog.

GET

/dashboards/catalog

const url = 'https://api.siteqwality.com/dashboards/catalog';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/dashboards/catalog \
  --header 'Authorization: Bearer <token>'

Every source with its measures, aggregations, fields and intervals, for the widget editor.

Authorizations

bearer_auth

Responses

200

The catalog

application/json

object

sources

required

Array<object>

object

key

required

string

Allowed values: monitors incidents rum logs metrics traces

label

required

string

description

required

string

intervals

required

Bucket sizes in seconds the source can serve, ascending.

Array<integer>

measures

required

Array<object>

object

key

required

string

label

required

string

unit

required

string

Allowed values: ms seconds percent count bytes score per_second none

aggregations

required

Allowed aggregations; empty means the measure is already reduced (uptime, counts).

Array<string>

Allowed values: avg sum min max count p50 p75 p90 p95 p99 rate

default_aggregation

One of:

null
string

null

description

required

string

scalar_only

required

Only meaningful as a single value (for example open incidents now).

boolean

fields

required

Array<object>

object

key

required

A field key, or tag:* for dynamic tag:<key> fields.

string

label

required

string

kind

required

string

Allowed values: id enum text number

ops

required

Array<string>

Allowed values: in not_in contains not_contains gt gte lt lte

group_by

required

boolean

variable

required

boolean

requires_metric

required

boolean

Example

{
  "sources": [
    {
      "key": "monitors",
      "measures": [
        {
          "unit": "ms",
          "aggregations": [
            "avg"
          ],
          "default_aggregation": "avg"
        }
      ],
      "fields": [
        {
          "kind": "id",
          "ops": [
            "in"
          ]
        }
      ]
    }
  ]
}

401

Missing or invalid authentication