NEnetdata
charts

Time series data queries

Multi-node, multi-context, multi-instance, multi-dimension data queries, with time and metric aggregation.

post/api/v3/spaces/{spaceID}/rooms/{roomID}/data

Request

Path parameters

spaceIDstring uuid required

The unique identifier of the requested space.

roomIDstring uuid required

The unique identifier of the requested room.

Request body

format'json2'

The format of the data to be returned. Only json2 is currently supported by Netdata Cloud.

optionsstring[]

Options that affect data generation, more info on each option : https://learn.netdata.cloud/api#/data/dataQuery2.

timeoutinteger

Timeout defined in milliseconds.

Example request

{
  "aggregations": {
    "metrics": [
      {
        "group_by": [
          "selected"
        ],
        "group_by_label": [
          "a_label_key"
        ]
      }
    ],
    "time": {
      "time_group": "min",
      "time_group_options": "countif",
      "time_resampling": 60
    }
  },
  "format": "json2",
  "options": [
    "jsonwrap",
    "minify"
  ],
  "scope": {
    "contexts": [
      "disk.space"
    ],
    "dimensions": [
      "avail",
      "used"
    ],
    "instances": [
      "disk_space./@bd498fed-8aa1-440c-a9d6-7c33db570608"
    ],
    "labels": [
      "filesystem:btrfs",
      "mount_point:/host/var/log"
    ],
    "nodes": [
      "node_id_1",
      "node_id_2"
    ]
  },
  "selectors": {
    "alerts": [
      "*"
    ],
    "contexts": [
      "*"
    ],
    "dimensions": [
      "sent",
      "received"
    ],
    "instances": [
      "instance1@machine_guid1",
      "instance2@machine_guid1",
      "instanceX@machine_guidX"
    ],
    "labels": [
      "*"
    ],
    "nodes": [
      "*"
    ]
  },
  "timeout": 12000,
  "window": {
    "after": 1745928492,
    "baseline": {
      "after": 1745928492,
      "before": 1745929392,
      "points": 100
    },
    "before": 1745929392,
    "points": 100
  }
}

Response

OK

apiinteger

The API version used.

functionsstring[]

A list of the supported Functions

Example response

{
  "agents": [
    {
      "claim_id": "550e8400-e29b-41d4-a716-446655440000",
      "mg": "550e8400-e29b-41d4-a716-446655440000",
      "nd": "550e8400-e29b-41d4-a716-446655440000",
      "nm": "my_node"
    }
  ],
  "api": 2,
  "summary": {
    "nodes": [
      {
        "mg": "550e8400-e29b-41d4-a716-446655440000",
        "nd": "550e8400-e29b-41d4-a716-446655440000",
        "nm": "my_node",
        "st": {
          "code": 200,
          "msg": "timed out"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.