---
title: "Query"
method: POST
path: "/api/v1/admin/scalability-dashboard/query"
tags: ["Admin APIs", "Scalability Dashboard"]
---

# Query

`POST /api/v1/admin/scalability-dashboard/query`

## Request body

- ScalabilityQueryRequest
  - `response_format` 'timeseries' | 'scalar', required
  - `queries` union[], required
    - union
      - MetricsQuerySpec
        - `data_source` 'metrics'
        - `name` string, required
        - `query` string, required
        - `aggregator` string, nullable
      - SpansQuerySpec
        - `data_source` 'spans'
        - `name` string, required
        - `search_query` string, required
        - `aggregation` string, required
        - `metric` string, nullable
        - `group_by` GroupBySpec[], nullable
          - `facet` string, required
          - `limit` integer
          - `sort` GroupBySortSpec
            - `aggregation` string
            - `order` 'asc' | 'desc'
  - `formulas` FormulaSpec[]
    - `formula` string, required
    - `name` string, nullable
  - `env` 'dev' | 'stage' | 'prod'
  - `from` string
  - `to` string
  - `granularity` 'hour' | 'day' | 'week' | 'month', nullable

## Response `200`

Successful Response

- ScalabilityQueryResponse
  - `status` 'ok' | 'not_configured' | 'error', required
  - `response_format` 'timeseries' | 'scalar', required
  - `series` TimeseriesSeriesResult[], nullable
    - `name` string, required
    - `group` object
    - `points` TimeseriesPoint[], required
      - `t` integer, required
      - `v` number, nullable
  - `rows` ScalarRowResult[], nullable
    - `group` object
    - `values` object, required
  - `error_category` 'auth' | 'rate_limit' | 'timeout' | 'upstream' | 'bad_request', nullable
  - `error_message` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api.md) · [All operations](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/carbonarc/carbon-arc-client-admin-api/revisions/a8ca30023371/schema)