Slos Service

Get Slo Status

Returns lowest compliance and remaining error budget (0-1 ratios) for an SLO grouping slice over a time window.

get/slo/slos/v1/{id}/status

Request

  • Base URL: https://api.eu1.coralogix.com/mgmt/openapi/5
  • URL: https://api.eu1.coralogix.com/mgmt/openapi/5/slo/slos/v1/{id}/status
  • Auth: API key in header Authorization

Path parameters

idstring required

Unique identifier of the SLO.

Query parameters

grouping_key_valuestring[]

Grouping label pairs that identify the slice to evaluate, passed as repeated query values. Each entry is one pair: the substring before the first comma is the label name (must not contain a comma), and the remainder of the entry (which may contain commas, or be empty) is the label value. Example: grouping_key_value=service,api&grouping_key_value=region,eu-west-1 or grouping_key_value=service, for an empty value. When omitted or empty, every permutation is considered. When provided, each label name must appear at most once and must be one of the SLO configured grouping labels; the slice includes every atomic permutation whose labels match the given pairs (a proper subset of grouping dimensions matches all permutations that agree on those labels). lowestCompliance and lowestRemainingErrorBudget are the minimum ratio across those matching permutations, not ratios recomputed from summed events across omitted dimensions.

fromstring date-time

Inclusive lower bound of the evaluation window. When omitted, defaults to the start of the SLO configured rolling time frame ending at the effective upper bound. RFC 3339 UTC date-time on a whole-minute instant (suffix Z, seconds 00, no fractional seconds).

tostring date-time

Exclusive upper bound of the evaluation window. When omitted, defaults to the current time with sub-minute precision truncated toward zero to the preceding whole UTC minute (for example 12:30:37Z becomes 12:30:00Z). When set, RFC 3339 UTC date-time on a whole-minute instant (suffix Z, seconds 00, no fractional seconds).

target_threshold_percentagenumber float

Optional override of the target threshold percentage for this evaluation, in the range 0-100. When omitted, the target threshold percentage configured on the SLO is used.

Response

computedAtstring date-time required

Time at which the evaluation was performed, as an RFC 3339 UTC timestamp on a whole-minute instant (suffix Z, no fractional seconds).

effectiveFromstring date-time required

Inclusive lower bound of the evaluation window that was applied, after defaults, as an RFC 3339 UTC whole-minute instant (suffix Z).

effectiveTostring date-time required

Exclusive upper bound of the evaluation window that was applied, after defaults, as an RFC 3339 UTC whole-minute instant (suffix Z).

effectiveWindowCompleteDataboolean required

When true, recorded source metrics for the evaluated grouping slice fully cover the applied evaluation window between effectiveFrom and effectiveTo, so lowestCompliance and lowestRemainingErrorBudget may be treated as final for that window. When false, the evaluation used partial data within that window. Completeness is determined only from effectiveFrom and effectiveTo (including after request defaults); it is independent of whether the SLO configured rolling time frame has matured since creation or last revision. For example, a short, fully recorded custom window may report true here while permutations in the configured rolling window still have incomplete historical coverage.

lowestCompliancenumber float required

Lowest compliance ratio among atomic permutations that match the evaluated grouping slice for the applied evaluation window, in the range 0-1 (minimum of per-permutation compliance ratios, not compliance from pooled good/total counts). When the slice is a single atomic permutation, this equals that permutation's compliance. When there are no events in the window, the value is 0.

lowestRemainingErrorBudgetnumber float required

Lowest remaining error budget ratio among atomic permutations that match the evaluated grouping slice for the applied evaluation window, in the range 0-1 (minimum of per-permutation remaining error budget ratios). When the slice is a single atomic permutation, this equals that permutation's remaining error budget. When there are no events in the window, the value is 0.

Changes

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