a13nDocs
API referenceEnvironments

Query Environment Metrics

POST/api/v1/environments/{environment_id}/metrics/query

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

environment_id*Environment Id

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/environments/string/metrics/query" \  -H "Content-Type: application/json" \  -d '{    "end": 0,    "metric": "system_cpu_busy_ratio",    "start": 0,    "step": 1  }'
{  "data": {    "result": [      null    ],    "resultType": "matrix"  },  "infos": [    "string"  ],  "status": "success",  "warnings": [    "string"  ]}