Skip to content

List a project's alerts grouped by rule (or SLO tier)

The Alerts page. A group is a rule (or an SLO tier) with at least one pending, firing, noData or silenced instance the filters keep; it carries its first 10 instances in the instance order (as GET alerts) and total. Groups are ordered by worstState (firing, noData, pending, silenced), then the latest latestChangeAt first, then owner ID. commonLabels are the labels every instance of the group shares (all of them, not only those returned); each instance's distinctLabels are the rest. The top-level counts are the project's instances by display state under every filter except state, and ruleErrors the rules in rule error. limit is 1-50 groups (default 20). A content read: unrecorded. 404 while alerting isn't offered (the console hides Alerting then).

GET
https://obs.ezghcloud.com/v1/organizations/{orgId}/projects/{projectId}/obs/alerts/groups

Authorization

  • apiKeyoptionalHTTP
  • oauthoptionalHTTP
  • sessionCookieoptionalAPI key in cookie

Path parameters

  • orgIdstringrequired
    format: uuid
  • projectIdstringrequired
    format: uuid

Query parameters

  • limitoptionalinteger

    The page size. Out of range is 400, never a clamp.

    maximum: 50, minimum: 1
    Default: 20
  • cursoroptionalstring

    The previous page's nextCursor. Bound to the organization, the list and its filters.

  • stateoptionalarray ofstring

    Only instances in these display states (repeatable).

  • severityoptionalarray ofstring

    Only instances whose severity label is one of these (repeatable).

  • labeloptionalarray ofstring

    Only instances whose labels match (repeatable): name=value, name!=value, name=~regex or name!~regex.

  • owneroptionalarray ofstring

    Only these owners' instances (repeatable): rule: or slo:.

  • qoptionalstring

    Only the instances of rules and SLOs whose name contains this (case-insensitive).

Returns

200

A page of groups.

JSON
  • countsobjectrequired

    The project's instances by display state under every filter except state, and its rules in rule error. Lower bounds when truncated.

    5 properties
    • firingintegerrequired
    • noDataintegerrequired
    • pendingintegerrequired
    • ruleErrorsintegerrequired
    • silencedintegerrequired
  • groupsarray ofobjectrequired
    9 properties
    • commonLabelsmap ofstringrequired

      The labels every one of its instances has, with the same value.

    • countsobjectrequired

      Its instances by display state.

      4 properties
      • firingintegerrequired
      • noDataintegerrequired
      • pendingintegerrequired
      • silencedintegerrequired
    • degradedbooleanrequired

      Its evaluations are delayed by an EZGH issue.

    • instancesarray ofobjectrequired

      Its first 10 instances in the instance order.

      13 properties
      • activeAtstringrequired

        UTC, millisecond precision: 2026-10-02T10:20:00.000Z.

        format: date-time
      • annotationsmap ofstringrequired

        Rendered.

      • distinctLabelsmap ofstringrequired

        labels without those every instance of its group (its rule, or SLO tier, under the list's filters) shares.

      • fingerprintstringrequired

        16 hex digits: the hash of the instance's labels.

      • firedAtstring | nullrequired
        format: date-time
      • labelsmap ofstringrequired
      • lastActiveAtstringrequired

        UTC, millisecond precision: 2026-10-02T10:20:00.000Z.

        format: date-time
      • ownerobjectrequired
        4 properties
        • idstringrequired
          format: uuid
        • kindstringrequired

          rule or slo.

        • namestringrequired
        • slugstringrequired

          alr_… or slo_… (empty in a dry run's instances).

      • resolvedAtstring | nullrequired
        format: date-time
      • silencedByarray ofstringrequired

        The active silences that mute it.

        format: uuid
      • statestringrequired

        pending, firing, noData or resolved (kept 15 minutes): the underlying state; a silenced one has silencedBy.

      • valuenumber | nullrequired
      • tieroptionalstring

        An SLO's tier: page or ticket.

    • latestChangeAtstringrequired

      The latest firedAt (or activeAt, when it hasn't fired) of its instances.

      format: date-time
    • ownerobjectrequired
      4 properties
      • idstringrequired
        format: uuid
      • kindstringrequired

        rule or slo.

      • namestringrequired
      • slugstringrequired
    • tierstring | nullrequired

      An SLO's tier (page or ticket); null for a rule.

    • totalintegerrequired

      Its instances the filters keep.

    • worstStatestringrequired

      firing, noData, pending or silenced. More may be added.

  • nextCursorstring | nullrequired
  • truncatedbooleanrequired

    True when the filters keep more instances than one request reads (20,000, the most severe state and the newest activeAt first): counts and each group's counts and total are then lower bounds, and groups whose instances all fall past the cap are missing. The filters that narrow the read are owner, severity, q, label name=value and name!=value, and state other than silenced; label regular expressions and state=silenced are applied to the instances read.

400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

401

unauthenticated: no credential, or one that doesn't check out.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

404

not_found: unknown, malformed, or in an organization the caller isn't in.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

503

unavailable: a dependency the request needs is down. Retry after Retry-After.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close