Skip to main content

Metrics service (v1)

Download OpenAPI specification:Download

metrics

Get metrics for given parameters

query Parameters
startTimestamp
required
integer <int64> >= 0

From

endTimestamp
required
integer <int64> >= 0

To

namespace
string

Service namespace

serviceName
string

Service name

metricName
required
string

Metric name

aggregation
string (AggregationOperator)
Enum: "MIN" "MAX" "AVG" "SUM"

Aggregation function for multi-timeseries results

step
integer >= 0

Mimir query step (resolution) in seconds

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "step": 0,
  • "commonLabels": {
    },
  • "metricEntryList": [
    ]
}

Get metric predictions for given parameters

query Parameters
startTimestamp
required
integer <int64> >= 0

From

endTimestamp
required
integer <int64> >= 0

To

namespace
required
string

Service namespace

serviceName
required
string

Service name

metricName
required
string

Metric name

step
integer >= 0

Mimir query step (resolution) in seconds

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "step": 0,
  • "commonLabels": {
    },
  • "metricEntryList": [
    ]
}

resources

Get current resources usage for a given service

query Parameters
serviceName
required
string
namespace
required
string
header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "pods": [
    ]
}

traffic

Get current traffic for a given service

query Parameters
startTimestamp
required
integer <int64> >= 0

From

endTimestamp
required
integer <int64> >= 0

To

serviceName
required
string

Service name

namespace
required
string

Namespace

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "pods": [
    ]
}