Skip to main content

Get a usage-metrics breakdown for a server

GET/v2/servers/{serverId}/usage-metrics/breakdown
API version
v2
Request method
GET
Operation ID
project-get-server-usage-metrics-breakdown

Request​

  • serverIdstring (uuid)required

    ID of the server whose usage-metrics breakdown is retrieved.

Responses​

Format
application/json
Description

Usage-metrics breakdown for the server

  • databasesarray of objectrequired

    Absolute database usage (CPU seconds per second or memory bytes), labelled with database_type and database_version.

    • Array[
      • *object
        • labelsobjectrequired

          Prometheus labels identifying the series, e.g. project, stack, container, database_type or database_version; empty for an aggregated series.

          • *string
        • samplesarray of objectrequired
          • Array[
            • *object
              • timestring (date-time)required
              • valuenumberrequired
            ]
      ]
  • limitnumberrequired

    Current server limit in the unit of the requested metric (CPU seconds per second or memory bytes).

  • projectsarray of objectrequired

    Usage per project relative to the server limit, labelled with project.

    • Array[
      • *object
        • labelsobjectrequired

          Prometheus labels identifying the series, e.g. project, stack, container, database_type or database_version; empty for an aggregated series.

          • *string
        • samplesarray of objectrequired
          • Array[
            • *object
              • timestring (date-time)required
              • valuenumberrequired
            ]
      ]
Content-Type: application/json

{
"databases": [
{
"labels": {
"project": "p-XXXXXX"
},
"samples": [
{
"time": "2026-11-10T12:00:00.000Z",
"value": 0.42
}
]
}
],
"limit": 4,
"projects": [
{
"labels": {
"project": "p-XXXXXX"
},
"samples": [
{
"time": "2026-11-10T12:00:00.000Z",
"value": 0.42
}
]
}
]
}
{
"properties": {
"databases": {
"description": "Absolute database usage (CPU seconds per second or memory bytes), labelled with `database_type` and `database_version`.",
"items": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Prometheus labels identifying the series, e.g. `project`, `stack`, `container`, `database_type` or `database_version`; empty for an aggregated series.",
"example": {
"project": "p-XXXXXX"
},
"type": "object"
},
"samples": {
"items": {
"properties": {
"time": {
"example": "2026-11-10T12:00:00.000Z",
"format": "date-time",
"type": "string"
},
"value": {
"example": 0.42,
"type": "number"
}
},
"required": [
"time",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"labels",
"samples"
],
"type": "object"
},
"type": "array"
},
"limit": {
"description": "Current server limit in the unit of the requested metric (CPU seconds per second or memory bytes).",
"example": 4,
"type": "number"
},
"projects": {
"description": "Usage per project relative to the server limit, labelled with `project`.",
"items": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Prometheus labels identifying the series, e.g. `project`, `stack`, `container`, `database_type` or `database_version`; empty for an aggregated series.",
"example": {
"project": "p-XXXXXX"
},
"type": "object"
},
"samples": {
"items": {
"properties": {
"time": {
"example": "2026-11-10T12:00:00.000Z",
"format": "date-time",
"type": "string"
},
"value": {
"example": 0.42,
"type": "number"
}
},
"required": [
"time",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"labels",
"samples"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"projects",
"databases",
"limit"
],
"type": "object"
}

Usage examples​

$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v2/servers/f0f86186-0a5a-45b2-aa33-502777496347/usage-metrics/breakdown?metric=cpu&from=1985-10-26T01%3A21%3A00.000Z&to=1985-10-26T01%3A21%3A00.000Z
import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";

const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.project.getServerUsageMetricsBreakdown({
"serverId": "f0f86186-0a5a-45b2-aa33-502777496347",
"queryParameters": {
"metric": "cpu",
"from": "1985-10-26T01:21:00.000Z",
"to": "1985-10-26T01:21:00.000Z"
}
});

assertStatus(response, 200);

use \Mittwald\ApiClient\Generated\V2\Clients\Project\GetServerUsageMetricsBreakdown\GetServerUsageMetricsBreakdownRequest;

$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetServerUsageMetricsBreakdownRequest(
serverId: "f0f86186-0a5a-45b2-aa33-502777496347"
))
->withMetric("cpu")
->withFrom("1985-10-26T01:21:00.000Z")
->withTo("1985-10-26T01:21:00.000Z");
$response = $client->project()->getServerUsageMetricsBreakdown($request);

var_dump($response->getBody();

On this page